org.apache.axis2
Class AxisFault

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              java.rmi.RemoteException
                  org.apache.axis2.AxisFault

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DeploymentException, PhaseException

public class AxisFault

extends java.rmi.RemoteException

An exception which maps cleanly to a SOAP fault. This is a base class for exceptions which are mapped to faults.

See Also:

SOAP1.2 specification, SOAP1.1 Faults SOAP faults contain

1. A fault string
2. A fault code
3. A fault actor
4. Fault details; an xml tree of fault specific elements

As SOAP1.2 faults are a superset of SOAP1.1 faults, this type holds soap1.2 fault information. When a SOAP1.1 fault is created, spurious information can be discarded. Mapping

 SOAP1.2              SOAP1.1
 node                 faultactor
 reason(0).text       faultstring
 faultcode.value      faultcode
 faultcode.subcode    (discarded)
 detail               detail
 role                 (discarded)
 

, Serialized Form

Constructor Summary

AxisFault(SOAPFault fault)
Make an AxisFault from an incoming SOAPFault

AxisFault(java.lang.String message)

AxisFault(java.lang.String messageText, javax.xml.namespace.QName faultCode, java.lang.Throwable cause)

AxisFault(java.lang.String messageText, java.lang.String faultCode)

AxisFault(java.lang.String messageText, java.lang.String faultCode, java.lang.Throwable cause)

AxisFault(java.lang.String message, java.lang.Throwable cause)

AxisFault(java.lang.Throwable cause)
construct a fault from an exception TODO: handle AxisFaults or SOAPFaultException implementations differently?

Method Summary

void	addHeader(SOAPHeader header) Add a header to the list of fault headers
void	addReason(java.lang.String text) Add a reason for the fault in the empty "" language
void	addReason(java.lang.String text, java.lang.String language) Add a reason for the fault
OMElement	getDetail() Get the current fault detail
java.lang.String	getNodeURI() Get the faulting node uri.
java.util.ListIterator	headerIterator() Iterate over all of the headers
java.util.List	headers() Get at the headers.
static AxisFault	makeFault(java.lang.Exception e) Make an AxisFault based on a passed Exception.
void	setDetail(OMElement detail) Set the entire detail element of the fault
void	setNodeURI(java.lang.String nodeURI) Set the faulting node uri.

Methods inherited from class java.rmi.RemoteException

getCause, getMessage

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AxisFault

public AxisFault(java.lang.Throwable cause)

construct a fault from an exception TODO: handle AxisFaults or SOAPFaultException implementations differently?

Parameters:

cause -

AxisFault

public AxisFault(java.lang.String message)

Parameters:

message -

AxisFault

public AxisFault(java.lang.String message,
                 java.lang.Throwable cause)

Parameters:

message -

cause -

AxisFault

public AxisFault(java.lang.String messageText,
                 java.lang.String faultCode)

Parameters:

messageText - - this will appear as the Text in the Reason information item of SOAP Fault

faultCode - - this will appear as the Value in the Code information item of SOAP Fault

AxisFault

public AxisFault(java.lang.String messageText,
                 java.lang.String faultCode,
                 java.lang.Throwable cause)

Parameters:

messageText - - this will appear as the Text in the Reason information item of SOAP Fault

faultCode - - this will appear as the Value in the Code information item of SOAP Fault

cause - - this will appear under the Detail information item of SOAP Fault

AxisFault

public AxisFault(java.lang.String messageText,
                 javax.xml.namespace.QName faultCode,
                 java.lang.Throwable cause)

Parameters:

messageText - - this will appear as the Text in the Reason information item of SOAP Fault

faultCode - - this will appear as the Value in the Code information item of SOAP Fault

cause - - this will appear under the Detail information item of SOAP Fault

AxisFault

public AxisFault(SOAPFault fault)

Make an AxisFault from an incoming SOAPFault

Parameters:

fault - that caused the failure

Method Detail

makeFault

public static AxisFault makeFault(java.lang.Exception e)

Make an AxisFault based on a passed Exception. If the Exception is already an AxisFault, simply use that. Otherwise, wrap it in an AxisFault. If the Exception is an InvocationTargetException (which already wraps another Exception), get the wrapped Exception out from there and use that instead of the passed one.

Parameters:

e - the Exception to build a fault for

Returns:

an AxisFault representing e

addReason

public void addReason(java.lang.String text,
                      java.lang.String language)

Add a reason for the fault

Parameters:

text - text message

language - language

addReason

public void addReason(java.lang.String text)

Add a reason for the fault in the empty "" language

Parameters:

text - text message

addHeader

public void addHeader(SOAPHeader header)

Add a header to the list of fault headers

Parameters:

header - to add.

headerIterator

public java.util.ListIterator headerIterator()

Iterate over all of the headers

Returns:

iterator

headers

public java.util.List headers()

Get at the headers. Useful for java1.5 iteration.

Returns:

the headers for this fault

getNodeURI

public java.lang.String getNodeURI()

Get the faulting node uri. SOAP1.2

Returns:

URI as a string or null

setNodeURI

public void setNodeURI(java.lang.String nodeURI)

Set the faulting node uri. SOAP1.2

getDetail

public OMElement getDetail()

Get the current fault detail

Returns:

om element

setDetail

public void setDetail(OMElement detail)

Set the entire detail element of the fault

Parameters:

detail -