| java.lang.Object java.lang.Throwable java.lang.Exception javax.xml.soap.SOAPException
All known Subclasses: com.sun.xml.messaging.saaj.SOAPExceptionImpl,
SOAPException | public class SOAPException extends Exception (Code) | | 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.
|
Constructor Summary | |
public | SOAPException() Constructs a SOAPException object with no
reason or embedded Throwable object. | public | SOAPException(String reason) Constructs a SOAPException object with the given
String as the reason for the exception being thrown. | 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. | public | SOAPException(Throwable cause) Constructs a SOAPException object initialized
with the given Throwable object. |
Method Summary | |
public Throwable | getCause() Returns the Throwable object embedded in this
SOAPException if there is one. | public String | getMessage() Returns the detail message for this SOAPException
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. |
SOAPException | public SOAPException()(Code) | | Constructs a SOAPException object with no
reason or embedded Throwable object.
|
SOAPException | public SOAPException(String reason)(Code) | | 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 |
SOAPException | public SOAPException(String reason, Throwable cause)(Code) | | 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 Parameters: cause - a Throwable object that is tobe embedded in this SOAPException object |
SOAPException | public SOAPException(Throwable cause)(Code) | | Constructs a SOAPException object initialized
with the given Throwable object.
|
getCause | public Throwable getCause()(Code) | | Returns the Throwable object embedded in this
SOAPException if there is one. Otherwise, this method
returns null .
the embedded Throwable object or null if there is none |
getMessage | public String getMessage()(Code) | | 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.
the error or warning message for thisSOAPException or, if it has none, themessage of the embedded Throwable object,if there is one |
initCause | public synchronized Throwable initCause(Throwable cause)(Code) | | 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.SOAPException(Throwable) or
SOAPException.SOAPException(String,Throwable) , meaning that its
cause field already has a value, this method cannot be
called even once.
Parameters: cause - the Throwable object that caused thisSOAPException object to be thrown. The value of thisparameter is saved for later retrieval by theSOAPException.getCause() method. A null value ispermitted and indicates that the cause is nonexistent orunknown. a reference to this SOAPException instance throws: IllegalArgumentException - if cause is thisThrowable object. (A Throwable objectcannot be its own cause.) throws: IllegalStateException - if the cause for this SOAPException objecthas already been initialized |
|
|