com.ibm.bpe.api

Class ApplicationFaultException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.bpe.api.ProcessException
  5. extended bycom.ibm.bpe.api.BpelException
  6. extended bycom.ibm.bpe.api.ApplicationFaultException
All implemented interfaces:
java.io.Serializable
Direct known subclasses:
ApplicationFaultException2

  1. public class ApplicationFaultException
  2. 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

Modifier and Type Field and Description
  1. protected
  2. java.lang.String
_faultName
  1. protected
  2. com.ibm.bpe.api.UTID
_utid
  1. static
  2. 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

Constructor and Description
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

Modifier and Type Method and Description
  1. java.io.Serializable
getFaultMessage()
Returns the fault message.
  1. java.lang.String
getFaultName()
Returns the fault name.
  1. com.ibm.bpe.api.UTID
getFaultUTID()
Returns the URI of the namespace of the fault.
  1. 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

  1. public static final java.lang.String COPYRIGHT
See Also:

_faultName

  1. protected java.lang.String _faultName

_utid

  1. protected com.ibm.bpe.api.UTID _utid

Constructor Detail

ApplicationFaultException

  1. public ApplicationFaultException( java.lang.Object[] vars,
  2. java.lang.String faultName,
  3. com.ibm.bpe.api.UTID utid,
  4. 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

  1. public java.lang.String getFaultName( )
Returns the fault name.
Specified by:
Returns:
String - The fault name.

getFaultUTID

  1. 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

  1. public void setFaultMessage(java.io.Serializable faultMessage)
Wraps the fault message into a ClientObjectWrapper object.
Parameters:
faultMessage - The fault message.

getFaultMessage

  1. public java.io.Serializable getFaultMessage( )
  2. 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.