Home » xml-commons-external-1.4.01-src » javax » xml » soap » [javadoc | source]
javax.xml.soap
public class: SOAPException [javadoc | source]
java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.xml.soap.SOAPException

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    JAXMException

An exception that signals that a SOAP exception has occurred. A SOAPException object may contain a String that gives the reason for the exception, an embedded Throwable object, or both. This class provides methods for retrieving reason messages and for retrieving the embedded Throwable object.

Typical reasons for throwing a SOAPException object are problems such as difficulty setting a header, not being able to send a message, and not being able to get a connection with the provider. Reasons for embedding a Throwable object include problems such as input/output errors or a parsing problem, such as an error in parsing a header.
Fields inherited from java.lang.Exception:
serialVersionUID
Constructor:
 public SOAPException() 
 public SOAPException(String reason) 
    Constructs a SOAPException object with the given String as the reason for the exception being thrown.
    Parameters:
    reason - a description of what caused the exception
 public SOAPException(Throwable cause) 
    Constructs a SOAPException object initialized with the given Throwable object.
 public SOAPException(String reason,
    Throwable cause) 
    Constructs a SOAPException object with the given String as the reason for the exception being thrown and the given Throwable object as an embedded exception.
    Parameters:
    reason - a description of what caused the exception
    cause - a Throwable object that is to be embedded in this SOAPException object
Method from javax.xml.soap.SOAPException Summary:
getCause,   getMessage,   initCause
Methods from java.lang.Throwable:
fillInStackTrace,   getCause,   getLocalizedMessage,   getMessage,   getStackTrace,   initCause,   printStackTrace,   printStackTrace,   printStackTrace,   setStackTrace,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.soap.SOAPException Detail:
 public Throwable getCause() 
    Returns the Throwable object embedded in this SOAPException if there is one. Otherwise, this method returns null.
 public String getMessage() 
    Returns the detail message for this SOAPException object.

    If there is an embedded Throwable object, and if the SOAPException object has no detail message of its own, this method will return the detail message from the embedded Throwable object.

 public synchronized Throwable initCause(Throwable cause) 
    Initializes the cause field of this SOAPException object with the given Throwable object.

    This method can be called at most once. It is generally called from within the constructor or immediately after the constructor has returned a new SOAPException object. If this SOAPException object was created with the constructor #SOAPException(Throwable) or #SOAPException(String,Throwable) , meaning that its cause field already has a value, this method cannot be called even once.