Class SOAPException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- javax.xml.soap.SOAPException
- All Implemented Interfaces:
- Serializable
public class SOAPException extends Exception
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.
- See Also:
- Serialized Form
Constructors
Constructor and Description |
---|
SOAPException() Constructs a |
SOAPException(String reason) Constructs a |
SOAPException(String reason,
Throwable cause) Constructs a |
SOAPException(Throwable cause) Constructs a |
Methods
Modifier and Type | Method and Description |
---|---|
Throwable |
getCause() Returns the |
String |
getMessage() Returns the detail message for this |
Throwable |
initCause(Throwable cause) Initializes the |
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Constructors
SOAPException
public SOAPException()
Constructs a SOAPException
object with no reason or embedded Throwable
object.
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
SOAPException
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
- aThrowable
object that is to be embedded in thisSOAPException
object
SOAPException
public SOAPException(Throwable cause)
Constructs a SOAPException
object initialized with the given Throwable
object.
Methods
getMessage
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.
- Overrides:
-
getMessage
in classThrowable
- Returns:
- the error or warning message for this
SOAPException
or, if it has none, the message of the embeddedThrowable
object, if there is one
getCause
public Throwable getCause()
Returns the Throwable
object embedded in this SOAPException
if there is one. Otherwise, this method returns null
.
- Overrides:
-
getCause
in classThrowable
- Returns:
- the embedded
Throwable
object ornull
if there is none
initCause
public 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.
- Overrides:
-
initCause
in classThrowable
- Parameters:
-
cause
- theThrowable
object that caused thisSOAPException
object to be thrown. The value of this parameter is saved for later retrieval by thegetCause()
method. Anull
value is permitted and indicates that the cause is nonexistent or unknown. - Returns:
- a reference to this
SOAPException
instance - Throws:
-
IllegalArgumentException
- ifcause
is thisThrowable
object. (AThrowable
object cannot be its own cause.) -
IllegalStateException
- if the cause for thisSOAPException
object has already been initialized
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/xml/soap/SOAPException.html