IBM WebSphere Application ServerTM
Release 8

com.ibm.bpe.api
Class ApplicationFaultException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.bpe.api.ProcessException
              extended by com.ibm.bpe.api.BpelException
                  extended by com.ibm.bpe.api.ApplicationFaultException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ApplicationFaultException2

public class ApplicationFaultException
extends BpelException

An ApplicationFaultException wraps fault responses from invoke, throw, or script activities. This exception is never thrown by the API because it is either handled by the fault handlers of the process or wrapped by an EngineMissingReplyException in case the fault is not handled. If the fault is not handled, it is stored as an unhandled exception of the activity instance.

Since:
5.1
See Also:
Serialized Form

Field Summary
protected  java.lang.String _faultName
           
protected  com.ibm.bpe.api.UTID _utid
           
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.bpe.api.BpelException
NAMESPACE_BPEL, NAMESPACE_WPC
 
Fields inherited from class com.ibm.bpe.api.ProcessException
_catalog, _cause, _id, _key, _message, _vars
 
Constructor Summary
ApplicationFaultException(java.lang.Object[] vars, java.lang.String faultName, com.ibm.bpe.api.UTID utid, java.io.Serializable faultMessage)
          Constructs an exception object with the specified fault name and message and remembers the values of the message variables passed.
 
Method Summary
 java.io.Serializable getFaultMessage()
          Returns the fault message.
 java.lang.String getFaultName()
          Returns the fault name.
 com.ibm.bpe.api.UTID getFaultUTID()
          Returns the URI of the namespace of the fault.
 void setFaultMessage(java.io.Serializable faultMessage)
          Wraps the fault message into a ClientObjectWrapper object.
 
Methods inherited from class com.ibm.bpe.api.ProcessException
getCause, getMessage, getMessage, getMessageID, getMessageKey, getMessageVariables, getRootCause, internPrintStackTrace, printStackTrace, printStackTrace, printStackTrace
 
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
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

_faultName

protected java.lang.String _faultName

_utid

protected com.ibm.bpe.api.UTID _utid
Constructor Detail

ApplicationFaultException

public ApplicationFaultException(java.lang.Object[] vars,
                                 java.lang.String faultName,
                                 com.ibm.bpe.api.UTID utid,
                                 java.io.Serializable faultMessage)
Constructs an exception object with the specified fault name and message and remembers the values of the message variables passed. The fault message can thus localize the cause of the error.

Parameters:
vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
faultName - The fault name.
utid - The namespace URI template ID of the fault name.
faultMessage - The fault message.
Method Detail

getFaultName

public java.lang.String getFaultName()
Returns the fault name.

Specified by:
getFaultName in class BpelException
Returns:
String - The fault name.

getFaultUTID

public com.ibm.bpe.api.UTID getFaultUTID()
Returns the URI of the namespace of the fault.

Returns:
UTID - The URI template ID of the fault namespace.

setFaultMessage

public void setFaultMessage(java.io.Serializable faultMessage)
Wraps the fault message into a ClientObjectWrapper object.

Parameters:
faultMessage - The fault message.

getFaultMessage

public java.io.Serializable getFaultMessage()
                                     throws DataHandlingException
Returns the fault message.

Returns:
Serializable - The message that is associated with the fault.
Throws:
DataHandlingException - Thrown if the message object cannot be deserialized.

IBM WebSphere Application ServerTM
Release 8