org.idoox.wasp
Class SoapFaultException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.idoox.wasp.SoapFaultException

All Implemented Interfaces:

java.io.Serializable

public class SoapFaultException

extends java.lang.RuntimeException

Exception representing deserialized SOAP Fault.

Since:

4.0

See Also:

Serialized Form

Component:

Core

Field Summary

protected Fault	fault
protected java.lang.String	faultActor
protected QName	faultCode
protected java.lang.String	faultNode
protected java.lang.String	faultString
protected Tokenizer	faultTokenizer
protected java.util.List	subcodes

Constructor Summary

SoapFaultException()
Server-side constructor.

SoapFaultException(Fault fault)
Client-side constructor.

SoapFaultException(QName faultCode, java.util.List subcodes, java.lang.String faultString, java.lang.String faultActor, java.lang.String faultNode, Tokenizer detailTokenizer)
Server-side exception constructor.

SoapFaultException(QName faultCode, java.lang.String faultString, java.lang.String faultActor, Tokenizer detailTokenizer)
Deprecated. SOAP 1.2 parameters added, use the full constructor instead of this one

Method Summary

void	clearFaultSubcodes() Clears the list of subcodes (ignored in SOAP 1.1 faults).
Tokenizer	getDetailTokenizer() Returns tokenizer expressing fault details.
java.lang.String	getFaultActor() Returns fault actor.
QName	getFaultCode() Returns fault code.
java.lang.String	getFaultNode() Returns fault node (this is new in SOAP 1.2, it identifies the faulting node; this is null in SOAP 1.1 faults).
java.lang.String	getFaultReason() Returns fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2).
java.lang.String	getFaultRole() Returns role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
java.lang.String	getFaultString() Returns fault string.
java.util.List	getFaultSubcodes() Returns fault subcodes (new in SOAP 1.2, always empty in SOAP 1.1).
java.lang.String	getMessage() Converts the exception to its string representation.
void	setDetailTokenizer(Tokenizer tokenizer) Sets the tokenizer expressing fault details.
void	setFaultActor(java.lang.String actor) Sets fault actor.
void	setFaultCode(QName faultCode) Sets fault code.
void	setFaultNode(java.lang.String node) Sets fault node (this is new in SOAP 1.2, it identifies the faulting node; this is ignored in SOAP 1.1 faults).
void	setFaultReason(java.lang.String faultReason) Sets fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2).
void	setFaultRole(java.lang.String role) Sets role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
void	setFaultString(java.lang.String faultString) Sets fault string.
void	setFaultSubcodes(java.util.List subcodes) Sets fault subcodes (new in SOAP 1.2, ignored in SOAP 1.1 faults).
java.lang.String	toString() Converts the exception to its string representation.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

faultCode

protected QName faultCode

subcodes

protected java.util.List subcodes

faultString

protected java.lang.String faultString

faultNode

protected java.lang.String faultNode

faultActor

protected java.lang.String faultActor

faultTokenizer

protected Tokenizer faultTokenizer

fault

protected Fault fault

Constructor Detail

SoapFaultException

public SoapFaultException(Fault fault)

Client-side constructor.

Parameters:

fault - the fault which initializes the exception

SoapFaultException

public SoapFaultException()

Server-side constructor.

SoapFaultException

public SoapFaultException(QName faultCode,
                          java.lang.String faultString,
                          java.lang.String faultActor,
                          Tokenizer detailTokenizer)

Deprecated. SOAP 1.2 parameters added, use the full constructor instead of this one

Server-side exception constructor.

Parameters:

faultCode - fault code

faultString - human readable fault string

faultActor - fault actor

detailTokenizer - tokenizer expressing fault details

SoapFaultException

public SoapFaultException(QName faultCode,
                          java.util.List subcodes,
                          java.lang.String faultString,
                          java.lang.String faultActor,
                          java.lang.String faultNode,
                          Tokenizer detailTokenizer)

Server-side exception constructor.

Parameters:

faultCode - fault code

subcodes - fault subcodes

faultString - human readable fault reason

faultActor - fault role

faultNode - fault node

detailTokenizer - tokenizer expressing fault details

Since:

4.0 SP1

Method Detail

getFaultCode

public QName getFaultCode()

Returns fault code.

Returns:

fault code

setFaultCode

public void setFaultCode(QName faultCode)

Sets fault code.

Parameters:

faultCode - the fault code

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

getFaultSubcodes

public java.util.List getFaultSubcodes()

Returns fault subcodes (new in SOAP 1.2, always empty in SOAP 1.1).

Returns:

the list of the subcodes, starting from the outermost; empty list when no subcode is present

Since:

4.0 SP1

setFaultSubcodes

public void setFaultSubcodes(java.util.List subcodes)

Sets fault subcodes (new in SOAP 1.2, ignored in SOAP 1.1 faults).

Parameters:

subcodes - the subcode list

Since:

4.0 SP1

clearFaultSubcodes

public void clearFaultSubcodes()

Clears the list of subcodes (ignored in SOAP 1.1 faults).

Since:

4.0 SP1

getFaultString

public java.lang.String getFaultString()

Returns fault string.

Returns:

the fault string

setFaultString

public void setFaultString(java.lang.String faultString)

Sets fault string.

Parameters:

faultString - the fault string to be set

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

getFaultReason

public java.lang.String getFaultReason()

Returns fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2).

Returns:

the fault reason

Since:

4.0 SP1

setFaultReason

public void setFaultReason(java.lang.String faultReason)

Sets fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2).

Parameters:

faultReason - the fault reason to be set

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

Since:

4.0 SP1

getFaultActor

public java.lang.String getFaultActor()

Returns fault actor.

Returns:

the fault actor

setFaultActor

public void setFaultActor(java.lang.String actor)

Sets fault actor.

Parameters:

actor - the actor to be set

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

getFaultRole

public java.lang.String getFaultRole()

Returns role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Returns:

the fault role

Since:

4.0 SP1

setFaultRole

public void setFaultRole(java.lang.String role)

Sets role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Parameters:

role - the role to be set up

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

Since:

4.0 SP1

getFaultNode

public java.lang.String getFaultNode()

Returns fault node (this is new in SOAP 1.2, it identifies the faulting node; this is null in SOAP 1.1 faults).

Returns:

the fault node

Since:

4.0 SP1

setFaultNode

public void setFaultNode(java.lang.String node)

Sets fault node (this is new in SOAP 1.2, it identifies the faulting node; this is ignored in SOAP 1.1 faults).

Parameters:

node - the node name (URI)

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

Since:

4.0 SP1

getDetailTokenizer

public Tokenizer getDetailTokenizer()
                             throws java.io.IOException

Returns tokenizer expressing fault details.

Returns:

the tokenizer

Throws:

java.io.IOException

setDetailTokenizer

public void setDetailTokenizer(Tokenizer tokenizer)

Sets the tokenizer expressing fault details.

Parameters:

tokenizer - the tokenizer

Throws:

java.lang.IllegalStateException - if the method is called on the read-only (client-side) exception

toString

public java.lang.String toString()

Converts the exception to its string representation.

Returns:

the string containg fault code

getMessage

public java.lang.String getMessage()

Converts the exception to its string representation.

Returns:

the string containg fault code