public class SOAPException extends Exception
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 and Description |
|---|
SOAPException()
Constructs a
SOAPException object with no
reason or embedded Throwable object. |
SOAPException(String reason)
Constructs a
SOAPException object with the
given String as the reason for the exception
being thrown. |
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. |
SOAPException(Throwable cause)
Constructs a
SOAPException object
initialized with the given Throwable
object. |
| Modifier and Type | Method and Description |
|---|---|
Throwable |
getCause()
Returns the
Throwable object embedded in
this SOAPException if there is one. |
String |
getMessage()
Returns the detail message for this
SOAPException object. |
Throwable |
initCause(Throwable cause)
Initializes the
cause field of this SOAPException object with the given Throwable object. |
addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic SOAPException()
SOAPException object with no
reason or embedded Throwable object.public SOAPException(String reason)
SOAPException object with the
given String as the reason for the exception
being thrown.reason - a description of what caused
the exceptionpublic SOAPException(String reason, Throwable cause)
SOAPException object with the
given String as the reason for the exception
being thrown and the given Throwable object as
an embedded exception.reason - a description of what caused
the exceptioncause - a Throwable object
that is to be embedded in this SOAPException
objectpublic SOAPException(Throwable cause)
SOAPException object
initialized with the given Throwable
object.cause - a Throwable object
that is to be embedded in this SOAPException
objectpublic String getMessage()
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.
getMessage in class ThrowableSOAPException or, if it has none, the message of
the embedded Throwable object, if there is
onepublic Throwable getCause()
Throwable object embedded in
this SOAPException if there is one. Otherwise,
this method returns null.public Throwable initCause(Throwable cause)
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(java.lang.Throwable)
or SOAPException(java.lang.String, java.lang.Throwable), meaning
that its cause field already has a value, this
method cannot be called even once.
initCause in class Throwablecause - the Throwable
object that caused this SOAPException object
to be thrown. The value of this parameter is saved for
later retrieval by the getCause() method.
A null value is permitted and indicates that the cause
is nonexistent or unknown.SOAPException
instanceIllegalArgumentException - if
cause is this Throwable object.
(A Throwable object cannot be its own
cause.)IllegalStateException - if this SOAPException object was created with SOAPException(java.lang.Throwable)
or SOAPException(java.lang.String, java.lang.Throwable), or this
method has already been called on this SOAPException object