SOAPException (Java Platform SE 6) (original) (raw)

javax.xml.soap

Class SOAPException

java.lang.Object extended by java.lang.Throwable java.lang.Exception javax.xml.soap.SOAPException

All Implemented Interfaces:

public class SOAPException

An exception that signals that a SOAP exception has occurred. ASOAPException object may contain a String 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 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

Constructor Summary
SOAPException() Constructs a SOAPException object with no reason or embedded Throwable object.
SOAPException(String reason) Constructs a SOAPException object with the givenString as the reason for the exception being thrown.
[SOAPException](../../../javax/xml/soap/SOAPException.html#SOAPException%28java.lang.String, java.lang.Throwable%29)(String reason,Throwable cause) Constructs a SOAPException object with the givenString 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.

Method Summary
Throwable	getCause() Returns the Throwable object embedded in thisSOAPException 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.

Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

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 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 a SOAPException object with the givenString 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

SOAPException

public SOAPException(Throwable cause)

Constructs a SOAPException object initialized with the given Throwable object.

Method Detail

getMessage

public String getMessage()

Returns the detail message for this SOAPException 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](../../../java/lang/Throwable.html#getMessage%28%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Returns:

the error or warning message for thisSOAPException or, if it has none, the message of the embedded Throwable object, if there is one

getCause

public Throwable getCause()

Returns the Throwable object embedded in thisSOAPException if there is one. Otherwise, this method returns null.

Overrides:

[getCause](../../../java/lang/Throwable.html#getCause%28%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Returns:

the embedded Throwable object or null 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)](../../../javax/xml/soap/SOAPException.html#SOAPException%28java.lang.String, java.lang.Throwable%29), meaning that itscause field already has a value, this method cannot be called even once.

Overrides:

[initCause](../../../java/lang/Throwable.html#initCause%28java.lang.Throwable%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Parameters:

cause - the Throwable object that caused thisSOAPException object to be thrown. The value of this parameter is saved for later retrieval by thegetCause() method. A null value is permitted and indicates that the cause is nonexistent or unknown.

Returns:

a reference to this SOAPException instance

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if cause is thisThrowable object. (A Throwable object cannot be its own cause.)

[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang") - if the cause for this SOAPException object has already been initialized

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Scripting on this page tracks web page traffic, but does not change the content in any way.