org.jibx.ws.soap
Class SoapFault

java.lang.Object
  org.jibx.ws.soap.SoapFault

public final class SoapFault
extends Object

SOAP fault object class.

Version:

1.0

Field Summary

static QName	FAULT_CODE_CLIENT The standard SOAP Client fault code.
static QName	FAULT_CODE_MUST_UNDERSTAND The standard SOAP MustUnderstand fault code.
static QName	FAULT_CODE_SERVER The standard SOAP Server fault code.
static QName	FAULT_CODE_VERSION_MISMATCH The standard SOAP VersionMismatch fault code.

Constructor Summary

SoapFault(QName faultCode, String faultString, String faultActor)

Method Summary

void	addDetailWriter(OutHandler writer) Add writer for detail item for a body-related fault condition.
boolean	equals(Object obj) Compares two objects for equality.
List	getDetails() Get details.
List	getDetailWriters() Get the list of OutHandlers, which will be called sequentially to write the SOAP Fault details.
String	getFaultActor() Get faultActor.
QName	getFaultCode() Get faultCode.
String	getFaultString() Get faultString.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FAULT_CODE_CLIENT

public static final QName FAULT_CODE_CLIENT

The standard SOAP Client fault code.

FAULT_CODE_SERVER

public static final QName FAULT_CODE_SERVER

The standard SOAP Server fault code.

FAULT_CODE_MUST_UNDERSTAND

public static final QName FAULT_CODE_MUST_UNDERSTAND

The standard SOAP MustUnderstand fault code.

FAULT_CODE_VERSION_MISMATCH

public static final QName FAULT_CODE_VERSION_MISMATCH

The standard SOAP VersionMismatch fault code.

Constructor Detail

SoapFault

public SoapFault(QName faultCode,
                 String faultString,
                 String faultActor)
          throws WsException

Parameters:

faultCode - Code for type of fault

faultString - Readable description of fault condition

faultActor - URI for fault origination (optional, may be null).

Throws:

WsException - if SOAP Fault details violate the SOAP specification

Method Detail

addDetailWriter

public void addDetailWriter(OutHandler writer)

Add writer for detail item for a body-related fault condition.

Parameters:

writer - the handler that will write the detail item

getFaultCode

public QName getFaultCode()

Get faultCode.

Returns:

faultCode

getFaultString

public String getFaultString()

Get faultString.

Returns:

faultString

getFaultActor

public String getFaultActor()

Get faultActor.

Returns:

faultActor

getDetails

public List getDetails()

Get details.

Returns:

details

getDetailWriters

public List getDetailWriters()

Get the list of OutHandlers, which will be called sequentially to write the SOAP Fault details.

Returns:

detail writers

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Compares two objects for equality. SoapFaults are considered equals if the faultCode, faultString, faultActor and details match. DetailWriters are ignored in the comparison.

Overrides:

equals in class Object