org.ws4d.java.service

Class InvocationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.ws4d.java.service.InvocationException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EventingException

public class InvocationException
extends java.lang.Exception

Exceptions of this class are thrown to indicate the occurrence of a user-defined fault during the invocation of a operation or the dispatching of a DefaultEventSource. The state encapsulated within such an exception allows a caller to determine the type of fault and extract any additional user-defined data attached to it.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	action
protected QName	code
protected ParameterValue	detail
protected DataStructure	reason
protected QName	subcode

Constructor Summary

Constructors

Constructor and Description
InvocationException(FaultMessage fault) Creates a new instance wrapping the specified fault message.
InvocationException(Fault fault, QName code) Creates a new instance wrapping the specified fault.
InvocationException(Fault fault, QName code, DataStructure reason, ParameterValue params) Creates a new instance representing the specified fault with the given reason and carrying the user-defined data params as additional fault details.
InvocationException(Fault fault, QName code, ParameterValue params) Creates a new instance representing the specified fault and carrying the given user-defined data params as additional fault details.
InvocationException(Fault fault, QName code, java.lang.String reason, ParameterValue params) Creates a new instance representing the specified fault with the given reason and carrying the user-defined data params as additional fault details.
InvocationException(java.lang.String action, QName code, QName subcode, DataStructure reason, ParameterValue detail) Create a new instance from the specified arguments.

Method Summary

Modifier and Type	Method and Description
protected static DataStructure	createReasonFromString(java.lang.String reason)
java.lang.String	getAction() Returns the wsa:Action URI of the fault this exception refers to.
QName	getCode() Returns the SOAP code of the fault this exception refers to.
ParameterValue	getDetail() Returns user-defined additional data about the encapsulated fault.
java.lang.String	getMessage()
DataStructure	getReason() Returns a data structure of LocalizedString instances, each in a different language/locale, representing the textual reason of the fault this exception refers to.
QName	getSubcode() Returns the SOAP subcode of the fault this exception refers to.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

action

protected final java.lang.String action

code

protected final QName code

subcode

protected final QName subcode

reason

protected final DataStructure reason

detail

protected final ParameterValue detail

Constructor Detail

InvocationException

public InvocationException(Fault fault,
                           QName code)

Creates a new instance wrapping the specified fault.

Parameters:

fault - the fault to encapsulate

InvocationException

public InvocationException(Fault fault,
                           QName code,
                           ParameterValue params)

Creates a new instance representing the specified fault and carrying the given user-defined data params as additional fault details.

Parameters:

fault - the fault this exception represents

params - user-defined additional data about the fault

InvocationException

public InvocationException(Fault fault,
                           QName code,
                           java.lang.String reason,
                           ParameterValue params)

Creates a new instance representing the specified fault with the given reason and carrying the user-defined data params as additional fault details.

Parameters:

fault - the fault this exception represents

reason - the fault reason

params - user-defined additional data about the fault

InvocationException

public InvocationException(Fault fault,
                           QName code,
                           DataStructure reason,
                           ParameterValue params)

Creates a new instance representing the specified fault with the given reason and carrying the user-defined data params as additional fault details.

Parameters:

fault - the fault this exception represents

reason - the fault reason

params - user-defined additional data about the fault

InvocationException

public InvocationException(FaultMessage fault)

Creates a new instance wrapping the specified fault message.

Parameters:

fault - the message to extract fault information from

InvocationException

public InvocationException(java.lang.String action,
                           QName code,
                           QName subcode,
                           DataStructure reason,
                           ParameterValue detail)

Create a new instance from the specified arguments.

Parameters:

action - the wsa:Action associated to the fault

code - the SOAP code of the fault

subcode - the SOAP subcode of the fault

reason - the fualt's reason, a data structure of LocalizedString , each for a different language or locale instances

detail - additional user-defined data further describing the fault

Method Detail

createReasonFromString

protected static DataStructure createReasonFromString(java.lang.String reason)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getAction

public java.lang.String getAction()

Returns the wsa:Action URI of the fault this exception refers to.

Returns:

the action associated to the fault wrapped by this exception

getCode

public QName getCode()

Returns the SOAP code of the fault this exception refers to.

Returns:

the SOAP code of the wrapped fault

getSubcode

public QName getSubcode()

Returns the SOAP subcode of the fault this exception refers to.

Returns:

the SOAP subcode of the wrapped fault

getReason

public DataStructure getReason()

Returns a data structure of LocalizedString instances, each in a different language/locale, representing the textual reason of the fault this exception refers to.

Returns:

the localized reasons for the fault

getDetail

public ParameterValue getDetail()

Returns user-defined additional data about the encapsulated fault.

Returns:

the additional fault-related data