Class SOAPException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- jakarta.xml.soap.SOAPException
-
- All Implemented Interfaces:
Serializable
public class SOAPException extends Exception
An exception that signals that a SOAP exception has occurred. ASOAPException
object may contain aString
that gives the reason for the exception, an embeddedThrowable
object, or both. This class provides methods for retrieving reason messages and for retrieving the embeddedThrowable
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 aThrowable
object include problems such as input/output errors or a parsing problem, such as an error in parsing a header.- Since:
- 1.6
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SOAPException()
Constructs aSOAPException
object with no reason or embeddedThrowable
object.SOAPException(String reason)
Constructs aSOAPException
object with the givenString
as the reason for the exception being thrown.SOAPException(String reason, Throwable cause)
Constructs aSOAPException
object with the givenString
as the reason for the exception being thrown and the givenThrowable
object as an embedded exception.SOAPException(Throwable cause)
Constructs aSOAPException
object initialized with the givenThrowable
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Throwable
getCause()
Returns theThrowable
object embedded in thisSOAPException
if there is one.String
getMessage()
Returns the detail message for thisSOAPException
object.Throwable
initCause(Throwable cause)
Initializes thecause
field of thisSOAPException
object with the givenThrowable
object.-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
SOAPException
public SOAPException()
Constructs aSOAPException
object with no reason or embeddedThrowable
object.
-
SOAPException
public SOAPException(String reason)
Constructs aSOAPException
object with the givenString
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 aSOAPException
object with the givenString
as the reason for the exception being thrown and the givenThrowable
object as an embedded exception.- Parameters:
reason
- a description of what caused the exceptioncause
- aThrowable
object that is to be embedded in thisSOAPException
object
-
SOAPException
public SOAPException(Throwable cause)
Constructs aSOAPException
object initialized with the givenThrowable
object.- Parameters:
cause
- aThrowable
object that is to be embedded in thisSOAPException
object
-
-
Method Detail
-
getMessage
public String getMessage()
Returns the detail message for thisSOAPException
object.If there is an embedded
Throwable
object, and if theSOAPException
object has no detail message of its own, this method will return the detail message from the embeddedThrowable
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 theThrowable
object embedded in thisSOAPException
if there is one. Otherwise, this method returnsnull
.
-
initCause
public Throwable initCause(Throwable cause)
Initializes thecause
field of thisSOAPException
object with the givenThrowable
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 thisSOAPException
object was created with the constructorSOAPException(Throwable)
orSOAPException(String,Throwable)
, meaning that itscause
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
-
-