javax.xml.soap

Class SOAPException


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.

Constructor Summary

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.

Method Summary

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.

Constructor Details

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 - 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.
Parameters:
cause - a Throwable object that is to be embedded in this SOAPException object

Method Details

getCause

public Throwable getCause()
Returns the Throwable object embedded in this SOAPException if there is one. Otherwise, this method returns null.
Returns:
the embedded Throwable object or null if there is none

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.

Returns:
the error or warning message for this SOAPException or, if it has none, the message of the embedded Throwable object, if there is one

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(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.

Returns:
a reference to this SOAPException instance

Copyright © 2005 Apache Web Services Project. All Rights Reserved.