com.arjuna.webservices

Class SoapFault

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.arjuna.webservices.SoapFault

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SoapFault11

public class SoapFault
extends Exception

Class representing a SOAP Fault

Author:

kevin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action The associated action.
protected String	detail The SOAP fault detail as a string.
protected boolean	headerFault The header fault flag.
protected String	node The SOAP fault reason.
protected String	reason The SOAP fault reason.
protected String	role The SOAP fault role.
protected SoapFaultType	soapFaultType The SOAP fault type.
protected QName	subcode The SOAP fault subcode.
protected QName	subSubcode The SOAP fault sub subcode.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SoapFault() Default constructor.
protected	SoapFault(SoapFaultType soapFaultType, QName subcode, String reason) Create a custom SOAP fault.
protected	SoapFault(SoapFaultType soapFaultType, QName subcode, String reason, String detail) Create a custom SOAP fault.
protected	SoapFault(SoapFaultType soapFaultType, String reason) Create a custom SOAP fault.
protected	SoapFault(SoapFaultType soapFaultType, String reason, String detail) Create a custom SOAP fault.
protected	SoapFault(Throwable th) Construct a SOAP fault based on a throwable.

Method Summary

Modifier and Type	Method and Description
static String	generateStackTrace(Throwable th) Generate a stack trace from a throwable.
String	getAction() Get the fault action.
String	getDetail() Get the SOAP fault detail.
String	getMessage() Get a message describing this fault.
String	getNode() Get the SOAP fault node.
String	getReason() Get the SOAP fault reason.
String	getRole() Get the SOAP fault role.
SoapFaultType	getSoapFaultType() Get the SOAP fault type.
QName	getSubcode() Get the SOAP fault subcode.
QName	getSubSubcode() Get the SOAP fault sub subcode.
boolean	isHeaderFault() Is this a fault from a SOAP header?
void	setAction(String action) Set the fault action.
void	setDetail(String detail) Set the SOAP fault detail.
void	setHeaderFault(boolean headerFault) Set the header fault flag.
void	setNode(String node) Set the SOAP fault node.
void	setReason(String reason) Set the SOAP fault reason.
void	setRole(String role) Set the SOAP fault role.
void	setSoapFaultType(SoapFaultType soapFaultType) Set the SOAP fault type.
void	setSubcode(QName subcode) Set the SOAP fault subcode.
void	setSubSubcode(QName subSubcode) Set the SOAP fault sub subcode.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

soapFaultType

protected SoapFaultType soapFaultType

The SOAP fault type.

subcode

protected QName subcode

The SOAP fault subcode.

subSubcode

protected QName subSubcode

The SOAP fault sub subcode.

reason

protected String reason

The SOAP fault reason.

node

protected String node

The SOAP fault reason.

detail

protected String detail

The SOAP fault detail as a string.

role

protected String role

The SOAP fault role.

headerFault

protected boolean headerFault

The header fault flag.

action

protected String action

The associated action.

Constructor Detail

SoapFault

protected SoapFault()

Default constructor.

SoapFault

protected SoapFault(Throwable th)

Construct a SOAP fault based on a throwable.

Parameters:

th - The throwable.

SoapFault

protected SoapFault(SoapFaultType soapFaultType,
                    QName subcode,
                    String reason)

Create a custom SOAP fault.

Parameters:

soapFaultType - the soap fault type.

subcode - The fault subcode.

reason - The fault reason.

SoapFault

protected SoapFault(SoapFaultType soapFaultType,
                    String reason)

Create a custom SOAP fault.

Parameters:

soapFaultType - the soap fault type.

reason - The fault reason.

SoapFault

protected SoapFault(SoapFaultType soapFaultType,
                    String reason,
                    String detail)

Create a custom SOAP fault.

Parameters:

soapFaultType - the soap fault type.

reason - The fault reason.

detail - The fault detail.

SoapFault

protected SoapFault(SoapFaultType soapFaultType,
                    QName subcode,
                    String reason,
                    String detail)

Create a custom SOAP fault.

Parameters:

soapFaultType - the soap fault type.

subcode - The fault subcode.

reason - The fault reason.

detail - The fault detail.

Method Detail

getSoapFaultType

public SoapFaultType getSoapFaultType()

Get the SOAP fault type.

Returns:

The SOAP fault type.

setSoapFaultType

public void setSoapFaultType(SoapFaultType soapFaultType)

Set the SOAP fault type.

Parameters:

soapFaultType - The SOAP fault type.

getSubcode

public QName getSubcode()

Get the SOAP fault subcode.

Returns:

The SOAP fault subcode.

setSubcode

public void setSubcode(QName subcode)

Set the SOAP fault subcode.

Parameters:

subcode - The SOAP fault subcode.

getSubSubcode

public QName getSubSubcode()

Get the SOAP fault sub subcode.

Returns:

The SOAP fault sub subcode.

setSubSubcode

public void setSubSubcode(QName subSubcode)

Set the SOAP fault sub subcode.

Parameters:

subSubcode - The SOAP fault sub subcode.

getReason

public String getReason()

Get the SOAP fault reason.

Returns:

The SOAP fault reason.

setReason

public void setReason(String reason)

Set the SOAP fault reason.

Parameters:

reason - The SOAP fault reason.

getNode

public String getNode()

Get the SOAP fault node.

Returns:

The SOAP fault node.

setNode

public void setNode(String node)

Set the SOAP fault node.

Parameters:

node - The SOAP fault node.

getRole

public String getRole()

Get the SOAP fault role.

Returns:

The SOAP fault role.

setRole

public void setRole(String role)

Set the SOAP fault role.

Parameters:

role - The SOAP fault role.

getDetail

public String getDetail()

Get the SOAP fault detail.

Returns:

The SOAP fault detail.

setDetail

public void setDetail(String detail)

Set the SOAP fault detail.

Parameters:

detail - The SOAP fault detail.

isHeaderFault

public boolean isHeaderFault()

Is this a fault from a SOAP header?

Returns:

true if generated by a SOAP header, false otherwise.

setHeaderFault

public void setHeaderFault(boolean headerFault)

Set the header fault flag.

Parameters:

headerFault - true if generated by a SOAP header, false otherwise.

getAction

public String getAction()

Get the fault action.

Returns:

The fault action.

setAction

public void setAction(String action)

Set the fault action.

Parameters:

action - The fault action.

getMessage

public String getMessage()

Get a message describing this fault.

Overrides:

getMessage in class Throwable

Returns:

The fault message.

generateStackTrace

public static String generateStackTrace(Throwable th)

Generate a stack trace from a throwable.

Parameters:

th - The throwable.

Returns:

The stack trace.