Home » axis2-1.5-src » org.apache » axis2 » [javadoc | source]
org.apache.axis2
public class: AxisFault [javadoc | source]
java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         java.io.IOException
            java.rmi.RemoteException
               org.apache.axis2.AxisFault

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    DeploymentException, DataRetrievalException, MexOMException, ClusteringFault, MexException, MexDisabledException, PhaseException

An exception which maps cleanly to a SOAP fault. This is a base class for exceptions which are mapped to faults.
Nested Class Summary:
class  AxisFault.FaultReason   
Fields inherited from java.rmi.RemoteException:
detail
Constructor:
 public AxisFault(String message) 
    Constructor.
    Parameters:
    message - the human-readable text describing the fault
 public AxisFault(SOAPFault fault) 
 protected AxisFault(Throwable cause) 
    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
 public AxisFault(SOAPFault fault,
    MessageContext faultCtx) 
 public AxisFault(String messageText,
    String faultCode) 
    Constructor.
    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
 public AxisFault(String messageText,
    QName faultCode) 
    Constructor
    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
 public AxisFault(String message,
    Throwable cause) 
    Constructor
    Parameters:
    message - this will appear as the Text in the Reason information item of SOAP Fault
    cause - the embedded Throwable that caused this fault
 public AxisFault(String message,
    MessageContext faultMessageContext) 
    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.
    faultMessageContext - A MessageContext which must contain SOAP fault info
 public AxisFault(QName faultCode,
    String faultReason,
    Throwable cause) 
    Constructor
    Parameters:
    faultCode - - fault code of the message as a QName
    faultReason - - the reason for the fault. The language will be defaulted to 'en'
    cause - embedded fault which caused this one
 public AxisFault(String messageText,
    QName faultCode,
    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
 public AxisFault(String message,
    MessageContext faultMessageContext,
    Throwable cause) 
    Parameters:
    message -
    faultMessageContext -
    cause -
 public AxisFault(String messageText,
    String faultCode,
    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
 public AxisFault(QName faultCode,
    List faultSubCodes,
    String faultReason,
    Throwable cause) 
    Constructor
    Parameters:
    faultCode - - fault code of the message as a QName
    faultSubCodes - - list sub fault codes as a list if QNames
    faultReason - - the reason for the fault. The language will be defaulted to 'en'
    cause - embedded fault which caused this one
 public AxisFault(QName faultCode,
    String faultReason,
    String faultNode,
    String faultRole,
    OMElement faultDetail) 
    Constructor
    Parameters:
    faultCode - a QName for the fault code
    faultReason - the reason for the fault. The language will be defaulted to 'en'
    faultNode - a URL identifying the SOAP node generating this fault, or null
    faultRole - a URL identifying the SOAP role active when generating this fault, or null
    faultDetail - arbitrary XML containing application-specific fault data
 public AxisFault(SOAPFaultCode soapFaultCode,
    SOAPFaultReason soapFaultReason,
    SOAPFaultNode soapFaultNode,
    SOAPFaultRole soapFaultRole,
    SOAPFaultDetail soapFaultDetail) 
    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
    soapFaultReason - the fault reason
    soapFaultNode - the SOAPFaultNode representing the source node for this fault
    soapFaultRole - the SOAPFaultRole representing the source role for this fault
    soapFaultDetail - the SOAPFaultDetail containing any application-specific info
Method from org.apache.axis2.AxisFault Summary:
addHeader,   addReason,   addReason,   getDetail,   getFaultAction,   getFaultCode,   getFaultCodeElement,   getFaultDetailElement,   getFaultMessageContext,   getFaultNode,   getFaultNodeElement,   getFaultReasonElement,   getFaultRole,   getFaultRoleElement,   getFaultSubCodes,   getFaultType,   getMessage,   getNodeURI,   getReason,   headerIterator,   headers,   makeFault,   setDetail,   setFaultAction,   setFaultCode,   setFaultCode,   setFaultSubCodes,   setFaultType,   setNodeURI
Methods from java.rmi.RemoteException:
getCause,   getMessage
Methods from java.lang.Throwable:
fillInStackTrace,   getCause,   getLocalizedMessage,   getMessage,   getStackTrace,   initCause,   printStackTrace,   printStackTrace,   printStackTrace,   setStackTrace,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.axis2.AxisFault Detail:
 public  void addHeader(SOAPHeaderBlock header) 
    Add a header to the list of fault headers
 public  void addReason(String text) 
    Add a reason for the fault in the empty "" language
 public  void addReason(String text,
    String language) 
    Add a reason for the fault
 public OMElement getDetail() 
    Get the current fault detail
 public String getFaultAction() 
 public QName getFaultCode() 
 public SOAPFaultCode getFaultCodeElement() 
 public SOAPFaultDetail getFaultDetailElement() 
 public MessageContext getFaultMessageContext() 
    Returns the MessageContext representation of the fault if the fault was created by providing that.
 public String getFaultNode() 
 public SOAPFaultNode getFaultNodeElement() 
 public SOAPFaultReason getFaultReasonElement() 
 public String getFaultRole() 
 public SOAPFaultRole getFaultRoleElement() 
 public List getFaultSubCodes() 
 public int getFaultType() 
 public String getMessage() 
    Returns the detail message, including the message from the cause, if any, of this exception.
 public String getNodeURI() 
    Get the faulting node uri. SOAP1.2
 public String getReason() 
    Returns the first fault reason, if available. If not found, returns null.
 public ListIterator headerIterator() 
    Iterate over all of the headers
 public List headers() 
    Get at the headers. Useful for java1.5 iteration.
 public static AxisFault makeFault(Throwable 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.
 public  void setDetail(OMElement detail) 
    Set the entire detail element of the fault
 public  void setFaultAction(String faultAction) 
    Set the (OPTIONAL) action value for the fault message
 public  void setFaultCode(QName soapFaultCode) 
 public  void setFaultCode(String soapFaultCode) 
 public  void setFaultSubCodes(List faultSubCodes) 
 public  void setFaultType(int faultType) 
 public  void setNodeURI(String nodeURI) 
    Set the faulting node uri. (SOAP1.2)