com.ibm.bpe.api
Class ProcessException
java.lang.Object
java.lang.Throwable
java.lang.Exception
com.ibm.bpe.api.ProcessException
- All Implemented Interfaces:
- java.io.Serializable
- Direct Known Subclasses:
- ActivityNameNotUniqueException, ApplicationNotStartedException, ApplicationVetoException, BpelException, CannotAccessObjectException, CannotDeleteNamespaceException, ClientException, CouldNotCreateWSIFPort_ProcessException, CreateFailedException, CreateRejectedException, DatabaseException, DataHandlingException, EngineActivityCorrelationHandlingFailureException, EngineActivityStoppedException, EngineAmbiguousActivityException, EngineAmbiguousPropertyDefinitionException, EngineAssignmentFailureExceptionException, EngineAuthorizationPluginException, EngineBaseClassNotFoundException, EngineCannotDeleteProcessException, EngineCannotDeserializeReplyContextException, EngineCannotOpenCompensationSphereException, EngineCannotResolveEndpointException, EngineCannotResolveReplacementStringException, EngineCannotUnwrapReplyContextException, EngineCompensateActivityFailedExceptionException, EngineCompensationNotSupportedException, EngineConditionEvaluationException, EngineConflictingProcessException, EngineCorrelationSetAlreadyInitializedException, EngineCreateServiceReferenceException, EngineCustomAttributeAccessViolationException, EngineDuplicateAwaitedEventException, EngineErrorInActivityCustomPropertyResolutionException, EngineErrorInDescriptionResolutionException, EngineEventHandlerCorrelationHandlingFailureException, EngineEventNotKnownException, EngineEverybodyWorkItemException, EngineExitConditionFailedException, EngineImplQualTranMustBeGlobalException, EngineIncompatibleTypesException, EngineIncompleteUserInputException, EngineInstanceLocationFailureException, EngineInvalidCompensationSphereDescriptorException, EngineInvalidNamespaceURIException, EngineInvalidReplacementVariableException, EngineJmsApiContextException, EngineLastAdminWorkItemException, EngineMessageAndCorrelationSetMismatchException, EngineNoInitialReceiveException, EngineNoServiceRefTypeException, EngineNotAuthorizedException, EngineNullMessageException, EngineParameterNullException, EngineParentProcessContextException, EngineProcessCannotBeMigratedException, EngineProcessInstanceNameNotUniqueException, EngineProcessModelDoesNotExistException, EngineProcessModelStoppedException, EngineProcessReaderWorkItemException, EngineProcessStarterDeletedException, EngineRefQualDeliverAsyncAtMustBeCommitException, EngineRepeatedCompensationExceptionException, EngineScopeInitializationFailureException, EngineSelectionFailureExceptionException, EngineSubProcessHasNoMatchingEventException, EngineUnknownActivityException, EngineUnsupportedJumpException, EngineVariableDoesNotExistException, EngineWrongActivityNameException, EngineWrongKindException, EngineWrongMessageTypeException, EngineWrongStateException, EngineWrongTaskTemplateException, ExecuteInputOnlyOperation_NotSupportedException, GenericErrorException, GroupWorkItemException, HumanTaskManagerException, IdAndCorrelationSetMismatchException, IdWrongFormatException, IdWrongTypeException, ImplementationNotFoundException, InterOpException, InvalidLengthException, InvalidMessagePartTypeException, InvalidMessageTypeException, InvalidObjectNameException, InvalidParameterException, InvalidParameterValueException, InvalidPropertyAliasTypeException, InvalidStoredQueryParametersException, MandatoryParameterMissingException, MessagePartNotFoundException, MessagePartQueryFailedException, MethodNotApplicableException, MissingPartsException, MultipleInstanceException, NoMacroFlowException, NotSerializableException, ObjectDoesNotExistException, ProcessBindingMissingFormatTypeException, ProcessBindingMissingTypeMappingException, ProcessInputTypeNameNullException, ProcessInputTypeSystemNullException, ProcessInputUnknownTypeSystemException, ProcessInstanceNotUniqueException, ProcessOperationCannotFindModelException, ProcessOperationCannotInvokeException, ProcessOperationFailedException, ProcessOperationFaultNameNotSetException, ProcessOperationMissingFaultMessageException, ProcessOperationNoOutputMessageException, ProcessOperationNotKnownByPortException, ProcessOperationUnknownFaultMessageTypeException, ProcessTemplateNotFoundException, QueryCannotJoinException, QueryException, QueryInvalidOperandException, QueryInvalidParameterException, QueryInvalidTimestampException, QueryTableException, QueryTableException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, SendReplyErrorException, ServiceNotUniqueException, StoredQueryNameNotUniqueException, SystemFaultException, TaskManagerNotFoundException, TemplateInUseException, UnexpectedFailureException, UserRegistryException, WorkItemManagerException, XMLSchemaValidationException
public class ProcessException
- extends java.lang.Exception
This is the base class for all exceptions thrown by the Business Flow Manager EJB API.
It is a best practice to catch all exceptions with a final catch(ProcessException) statement.
This statement helps to ensure the upward compatibility of your application program
because it takes account of all future exceptions that can occur.
- Since:
- 5.0
- See Also:
- Serialized Form
Field Summary |
protected java.lang.String |
_catalog
|
protected java.lang.Throwable |
_cause
|
protected java.lang.String |
_id
|
protected java.lang.String |
_key
|
protected java.lang.String |
_message
|
protected java.lang.Object[] |
_vars
|
static java.lang.String |
COPYRIGHT
|
Constructor Summary |
ProcessException(java.lang.String message)
Constructs an exception object from the error message passed. |
ProcessException(java.lang.String key,
java.lang.Object[] vars,
java.lang.String id)
Constructs an exception object with the specified message key and remembers
the values of the message variables passed. |
ProcessException(java.lang.String key,
java.lang.Object[] vars,
java.lang.String id,
java.lang.Throwable cause)
Constructs an exception object with the specified message key and exception and
remembers the values of the message variables passed. |
ProcessException(java.lang.String catalog,
java.lang.String key,
java.lang.Object[] vars,
java.lang.String id,
java.lang.Throwable cause)
Constructs an exception object with the specified message key and exception and
remembers the values of the message variables passed. |
ProcessException(java.lang.String message,
java.lang.Throwable cause)
Constructs an exception object from the error message and the exception passed. |
ProcessException(java.lang.Throwable cause)
Constructs an exception object from the exception passed. |
Method Summary |
java.lang.Throwable |
getCause()
Returns the nested exception. |
java.lang.String |
getMessage()
Returns the message text of the exception object. |
java.lang.String |
getMessage(java.util.Locale locale)
Returns the message text of the exception object in the specified language. |
java.lang.String |
getMessageID()
Returns the message id. |
java.lang.String |
getMessageKey()
Returns the message key. |
java.lang.Object[] |
getMessageVariables()
Returns the values of the message variables. |
java.lang.Throwable |
getRootCause()
Returns the root exception of this exception. |
void |
internPrintStackTrace(java.io.PrintWriter s)
Prints this exception to the specified print writer. |
void |
printStackTrace()
Prints this exception to the standard error stream. |
void |
printStackTrace(java.io.PrintStream s)
Prints this exception to the specified print stream. |
void |
printStackTrace(java.io.PrintWriter s)
Prints this exception to the specified print writer. |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- See Also:
- Constant Field Values
_catalog
protected java.lang.String _catalog
_message
protected java.lang.String _message
_key
protected java.lang.String _key
_id
protected java.lang.String _id
_vars
protected java.lang.Object[] _vars
_cause
protected java.lang.Throwable _cause
ProcessException
public ProcessException(java.lang.String message)
- Constructs an exception object from the error message passed.
- Parameters:
message
- The error message.
ProcessException
public ProcessException(java.lang.Throwable cause)
- Constructs an exception object from the exception passed.
- Parameters:
cause
- The exception that was thrown.
ProcessException
public ProcessException(java.lang.String message,
java.lang.Throwable cause)
- Constructs an exception object from the error message and the exception passed.
- Parameters:
message
- The error message.cause
- The exception that was thrown.
ProcessException
public ProcessException(java.lang.String key,
java.lang.Object[] vars,
java.lang.String id)
- Constructs an exception object with the specified message key and remembers
the values of the message variables passed. The error message can thus localize
the cause of the error.
- Parameters:
key
- The message key.vars
- The values of the message variables. Can be an empty array. If the array contains objects,
they must be Serializable.id
- The message id.
ProcessException
public ProcessException(java.lang.String key,
java.lang.Object[] vars,
java.lang.String id,
java.lang.Throwable cause)
- Constructs an exception object with the specified message key and exception and
remembers the values of the message variables passed. The error message can thus
localize the cause of the error.
- Parameters:
key
- The message key.vars
- The values of the message variables. Can be an empty array. If the array contains objects,
they must be Serializable.id
- The message id.cause
- The exception that was thrown.
ProcessException
public ProcessException(java.lang.String catalog,
java.lang.String key,
java.lang.Object[] vars,
java.lang.String id,
java.lang.Throwable cause)
- Constructs an exception object with the specified message key and exception and
remembers the values of the message variables passed. The error message can thus
localize the cause of the error.
- Parameters:
catalog
- The catalog which have to be used to retrieve the message.key
- The message key.vars
- The values of the message variables. Can be an empty array. If the array contains objects,
they must be Serializable.id
- The message id.cause
- The exception that was thrown.
getMessage
public final java.lang.String getMessage()
- Returns the message text of the exception object. If the exception object contains a
message key, the message text is returned in the default language.
- Overrides:
getMessage
in class java.lang.Throwable
- Returns:
- String -
The message text.
getMessage
public java.lang.String getMessage(java.util.Locale locale)
- Returns the message text of the exception object in the specified language. If the exception object contains a
message key, the message text is returned in the specified language.
- Parameters:
locale
- The locale of the message catalog to be used. Is ignored if the exception object
does not contain a message key.
- Returns:
- String -
The message text.
getMessageKey
public final java.lang.String getMessageKey()
- Returns the message key.
- Returns:
- String -
The message key. If a message key is not specified, null is returned.
getMessageID
public final java.lang.String getMessageID()
- Returns the message id.
- Returns:
- String -
The message id. If a message id is not specified, null is returned.
getMessageVariables
public final java.lang.Object[] getMessageVariables()
- Returns the values of the message variables.
- Returns:
- Object[] -
The array of variable values. An empty array is returned if there are no variable values.
getCause
public final java.lang.Throwable getCause()
- Returns the nested exception.
- Overrides:
getCause
in class java.lang.Throwable
- Returns:
- Throwable -
The nested exception. If there is no nested exception, null is returned.
getRootCause
public final java.lang.Throwable getRootCause()
- Returns the root exception of this exception.
- Returns:
- Throwable -
The root exception.
printStackTrace
public final void printStackTrace()
- Prints this exception to the standard error stream.
This call is forwarded to
printStackTrace(PrintWriter)
.
- Overrides:
printStackTrace
in class java.lang.Throwable
printStackTrace
public final void printStackTrace(java.io.PrintStream s)
- Prints this exception to the specified print stream.
This call will be forwarded to
printStackTrace(PrintWriter)
.
- Overrides:
printStackTrace
in class java.lang.Throwable
- Parameters:
s
- The print stream to write to.
printStackTrace
public final void printStackTrace(java.io.PrintWriter s)
- Prints this exception to the specified print writer. If this exception
has nested exceptions, the root exception's stack trace is printed.
- Overrides:
printStackTrace
in class java.lang.Throwable
- Parameters:
s
- The print writer to write to.
internPrintStackTrace
public final void internPrintStackTrace(java.io.PrintWriter s)
- Prints this exception to the specified print writer.
Qualifier changed from
protected
to public
because of split-package issues between core and common bundle.
- Parameters:
s
- The print writer to write to.