IBM WebSphere Application ServerTM
Release 8

com.ibm.task.api
Class TaskBusinessException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.task.api.TaskException
              extended by com.ibm.task.api.TaskBusinessException
All Implemented Interfaces:
java.io.Serializable

public class TaskBusinessException
extends TaskException

A TaskBusinessException wraps fault responses from tasks. This exception is used by the ReplyHandler to report WSDL declared faults.

Since:
6.0
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
TaskBusinessException(java.lang.Object[] vars, java.lang.String faultName, java.io.Serializable faultMessage, java.lang.String wsdlMessageLocalName, java.lang.String wsdlMessageNamespace, java.lang.String xsdTypeLocalName, java.lang.String xsdTypeNamespace)
          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.
 java.lang.String getWSDLMessageLocalName()
          Returns the WSDL message type local name.
 java.lang.String getWSDLMessageNamespace()
          Returns the WSDL message type namespace.
 java.lang.String getXSDTypeLocalName()
          Returns the XSD type local name.
 java.lang.String getXSDTypeNamespace()
          Returns the XSD type namespace.
 void setFaultMessage(java.io.Serializable faultMessage)
          Wraps the fault message into a ClientObjectWrapper object.
 
Methods inherited from class com.ibm.task.api.TaskException
getCause, getMessage, getMessage, getMessageID, getMessageKey, getMessageVariables, getRootCause, 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
Constructor Detail

TaskBusinessException

public TaskBusinessException(java.lang.Object[] vars,
                             java.lang.String faultName,
                             java.io.Serializable faultMessage,
                             java.lang.String wsdlMessageLocalName,
                             java.lang.String wsdlMessageNamespace,
                             java.lang.String xsdTypeLocalName,
                             java.lang.String xsdTypeNamespace)
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.
faultMessage - The fault message.
wsdlMessageLocalName - WSDL message type local name, if the type of the fault is specifed via a WSDL message, null otherwise.
wsdlMessageNamespace - The WSDL message type namespace, if the type of the fault is specifed via a WSDL message, null otherwise.
xsdTypeLocalName - The XSD message type local name, if the type of the fault is specifed via a single-part type typed WSDL message or via an XSD element or type. In case of an XSD element this is the local name of the XSD type the element refers to. Null otherwise.
xsdTypeNamespace - The XSD message type namespace, if the type of the fault is specifed via a single-part type typed WSDL message or via an XSD element or type. In case of an XSD element this is the namespace of the XSD type the element refers to. Null otherwise.
Method Detail

getFaultMessage

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

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

getFaultName

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

Returns:
The fault name.

getWSDLMessageLocalName

public java.lang.String getWSDLMessageLocalName()
Returns the WSDL message type local name.

Returns:
The local name of the WSDL message, if the type of the fault is specifed via a WSDL message, null otherwise.

getWSDLMessageNamespace

public java.lang.String getWSDLMessageNamespace()
Returns the WSDL message type namespace.

Returns:
The namespace of the WSDL message, if the type of the fault is specifed via a WSDL message, null otherwise.

getXSDTypeLocalName

public java.lang.String getXSDTypeLocalName()
Returns the XSD type local name.

Returns:
The local name of the XSD type, if the type of the fault is specifed via a single-part type typed WSDL message or via an XSD element or type. In case of an XSD element this is the local name of the XSD type the element refers to. Null otherwise.

getXSDTypeNamespace

public java.lang.String getXSDTypeNamespace()
Returns the XSD type namespace.

Returns:
The namespace of the XSD type, if the type of the fault is specifed via a single-part type typed WSDL message or via an XSD element or type. In case of an XSD element this is the namespace of the XSD type the element refers to. Null otherwise.

setFaultMessage

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

Parameters:
faultMessage - The fault message.

IBM WebSphere Application ServerTM
Release 8