| java.lang.Object
 java.lang.Throwable
java.lang.Exception
java.io.IOException
java.rmi.RemoteException
org.apache.axis2.AxisFault
All known Subclasses: org.apache.axis2.clustering.ClusteringFault, org.apache.axis2.dataretrieval.DataRetrievalException, org.apache.axis2.deployment.DeploymentException, org.apache.axis2.phaseresolver.PhaseException,
| AxisFault | | public class AxisFault extends RemoteException (Code) | | 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
See Also: SOAP1.1 Faults
See Also:
See Also: SOAP faults contain
See Also:
See Also: - A fault string
See Also: - A fault code
See Also: - A fault actor
See Also: - Fault details; an xml tree of fault specific elements
See Also:
See Also:
See Also: As SOAP1.2 faults are a superset of SOAP1.1 faults, this type holds soap1.2 fault information. When
See Also: a SOAP1.1 fault is created, spurious information can be discarded.
See Also: Mapping
See Also:
See Also: SOAP1.2 SOAP1.1
See Also: node faultactor
See Also: reason(0).text faultstring
See Also: faultcode.value faultcode
See Also: faultcode.subcode (discarded)
See Also: detail detail
See Also: role (discarded)
See Also:
|
| Constructor Summary | |
| public | AxisFault(String message)
Constructor. | | public | AxisFault(QName faultCode, String faultReason, Throwable cause)
Constructor
Parameters:
faultCode - - fault code of the message as a QName
Parameters:
faultReason - - the reason for the fault. | | public | AxisFault(QName faultCode, String faultReason, String faultNode, String faultRole, OMElement faultDetail)
Constructor
Parameters:
faultCode - a QName for the fault code
Parameters:
faultReason - the reason for the fault. | | public | AxisFault(SOAPFaultCode soapFaultCode, SOAPFaultReason soapFaultReason, SOAPFaultNode soapFaultNode, SOAPFaultRole soapFaultRole, SOAPFaultDetail soapFaultDetail)
This is just a convenience method for the user. | | public | AxisFault(SOAPFault fault)
| | public | AxisFault(SOAPFault fault, MessageContext faultCtx)
| | protected | AxisFault(Throwable cause)
Construct a fault from a Throwable. | | public | AxisFault(String messageText, String faultCode)
Constructor. | | public | AxisFault(String messageText, QName faultCode)
| | public | AxisFault(String message, Throwable cause)
| | public | AxisFault(String messageText, QName faultCode, Throwable cause)
| | public | AxisFault(String message, MessageContext faultMessageContext, Throwable cause)
| | public | AxisFault(String messageText, String faultCode, Throwable cause)
| | public | AxisFault(String message, MessageContext faultMessageContext)
Create an AxisFault by providing a textual message and a MessageContext
that contains the actual fault representation. |
| AxisFault | | public AxisFault(String message)(Code) | | Constructor.
Parameters:
message - the human-readable text describing the fault |
| AxisFault | | public AxisFault(QName faultCode, String faultReason, Throwable cause)(Code) | | Constructor
Parameters:
faultCode - - fault code of the message as a QName
Parameters:
faultReason - - the reason for the fault. The language will be defaulted to 'en'
Parameters:
cause - embedded fault which caused this one |
| AxisFault | | public AxisFault(QName faultCode, String faultReason, String faultNode, String faultRole, OMElement faultDetail)(Code) | | Constructor
Parameters:
faultCode - a QName for the fault code
Parameters:
faultReason - the reason for the fault. The language will be defaulted to 'en'
Parameters:
faultNode - a URL identifying the SOAP node generating this fault, or null
Parameters:
faultRole - a URL identifying the SOAP role active when generating this fault, or null
Parameters:
faultDetail - arbitrary XML containing application-specific fault data |
| AxisFault | | public AxisFault(SOAPFaultCode soapFaultCode, SOAPFaultReason soapFaultReason, SOAPFaultNode soapFaultNode, SOAPFaultRole soapFaultRole, SOAPFaultDetail soapFaultDetail)(Code) | | This is just a convenience method for the user. If you set these, do not use other methods
in this class to get and set things.
Any of the parameters can be null
Parameters:
soapFaultCode - the fault code
Parameters:
soapFaultReason - the fault reason
Parameters:
soapFaultNode - the SOAPFaultNode representing the source node for this fault
Parameters:
soapFaultRole - the SOAPFaultRole representing the source role for this fault
Parameters:
soapFaultDetail - the SOAPFaultDetail containing any application-specific info |
| AxisFault | | public AxisFault(SOAPFault fault)(Code) | | |
| AxisFault | | protected AxisFault(Throwable cause)(Code) | | Construct a fault from a Throwable. This is a protected constructor - in general
to make an AxisFault from an Exception, you should be calling AxisFault.makeFault(e),
which prevents AxisFaults within AxisFaults.
Parameters:
cause - the Throwable that caused the problem |
| AxisFault | | public AxisFault(String messageText, String faultCode)(Code) | | Constructor.
Parameters:
messageText - - this will appear as the Text in the Reason information item of SOAP Fault
Parameters:
faultCode - - this will appear as the Value in the Code information item of SOAP Fault |
| AxisFault | | public AxisFault(String messageText, QName faultCode)(Code) | | Constructor
Parameters:
messageText - this will appear as the Text in the Reason information item of SOAP Fault
Parameters:
faultCode - this will appear as the Value in the Code information item of SOAP Fault |
| AxisFault | | public AxisFault(String message, Throwable cause)(Code) | | Constructor
Parameters:
message - this will appear as the Text in the Reason information item of SOAP Fault
Parameters:
cause - the embedded Throwable that caused this fault |
| AxisFault | | public AxisFault(String messageText, QName faultCode, Throwable cause)(Code) | |
Parameters:
messageText - - this will appear as the Text in the Reason information item of SOAP Fault
Parameters:
faultCode - - this will appear as the Value in the Code information item of SOAP Fault
Parameters:
cause - - this will appear under the Detail information item of SOAP Fault |
| AxisFault | | public AxisFault(String message, MessageContext faultMessageContext, Throwable cause)(Code) | |
Parameters:
message -
Parameters:
faultMessageContext -
Parameters:
cause - |
| AxisFault | | public AxisFault(String messageText, String faultCode, Throwable cause)(Code) | |
Parameters:
messageText - - this will appear as the Text in the Reason information item of SOAP Fault
Parameters:
faultCode - - this will appear as the Value in the Code information item of SOAP Fault
Parameters:
cause - - this will appear under the Detail information item of SOAP Fault |
| AxisFault | | public AxisFault(String message, MessageContext faultMessageContext)(Code) | | Create an AxisFault by providing a textual message and a MessageContext
that contains the actual fault representation.
Parameters:
message - A string that's really only useful for logging.
Parameters:
faultMessageContext - A MessageContext which must contain SOAP fault info |
| addHeader | | public void addHeader(SOAPHeaderBlock header)(Code) | | Add a header to the list of fault headers
Parameters:
header - to add. |
| addReason | | public void addReason(String text)(Code) | | Add a reason for the fault in the empty "" language
Parameters:
text - text message |
| addReason | | public void addReason(String text, String language)(Code) | | Add a reason for the fault
Parameters:
text - text message
Parameters:
language - language |
| getDetail | | public OMElement getDetail()(Code) | | Get the current fault detail
om element |
| getFaultAction | | public String getFaultAction()(Code) | | the action value set for the fault message |
| getFaultMessageContext | | public MessageContext getFaultMessageContext()(Code) | | Returns the MessageContext representation of the fault if the fault
was created by providing that.
The MessageContext representing the fault message or null if thefault was not created with MessageContext representation. |
| getFaultSubCodes | | public List getFaultSubCodes()(Code) | | |
| getMessage | | public String getMessage()(Code) | | Returns the detail message, including the message from the cause, if any, of this exception.
the detail message |
| getNodeURI | | public String getNodeURI()(Code) | | Get the faulting node uri.
SOAP1.2
URI as a string or null |
| getReason | | public String getReason()(Code) | | Returns the first fault reason, if available. If not found, returns null.
faultReason |
| headerIterator | | public ListIterator headerIterator()(Code) | | Iterate over all of the headers
iterator |
| headers | | public List headers()(Code) | | Get at the headers. Useful for java1.5 iteration.
the headers for this fault |
| makeFault | | public static AxisFault makeFault(Throwable e)(Code) | | 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 an AxisFault representing e |
| setDetail | | public void setDetail(OMElement detail)(Code) | | Set the entire detail element of the fault
Parameters:
detail - an OMElement which MUST be |
| setFaultAction | | public void setFaultAction(String faultAction)(Code) | | Set the (OPTIONAL) action value for the fault message
Parameters:
faultAction - a String containing an action URI for the fault |
| setFaultCode | | public void setFaultCode(QName soapFaultCode)(Code) | | |
| setFaultCode | | public void setFaultCode(String soapFaultCode)(Code) | | |
| setNodeURI | | public void setNodeURI(String nodeURI)(Code) | | Set the faulting node uri. (SOAP1.2)
Parameters:
nodeURI - a String containing a URI indicating which SOAP Node faulted |
|
|