Jakarta SOAP with Attachments API 3.0.0 · jakarta.xml.soap.SOAPException

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.

Modifier and Type	Field and Description
private Throwable	cause Hides java.lang.Throwable.cause. The cause.
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	SOAPException() Constructs a `SOAPException` object with no reason or embedded `Throwable` object.
public	SOAPException(String a description of what caused the exception reason) Constructs a `SOAPException` object with the given `String` as the reason for the exception being thrown.
public	SOAPException(String a description of what caused the exception reason, Throwable a `Throwable` object that is to be embedded in this `SOAPException` object 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.
public	SOAPException(Throwable a `Throwable` object that is to be embedded in this `SOAPException` object cause) Constructs a `SOAPException` object initialized with the given `Throwable` object.

Method Summary

Modifier and Type	Method and Description
public Throwable	Returns: the embedded `Throwable` object or `null` if there is none getCause() Overrides java.lang.Throwable.getCause. Returns the `Throwable` object embedded in this `SOAPException` if there is one.
public String	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 getMessage() Overrides java.lang.Throwable.getMessage. Returns the detail message for this `SOAPException` object.
public synchronized Throwable	Returns: a reference to this `SOAPException` instance initCause(Throwable 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. cause) Overrides java.lang.Throwable.initCause. Initializes the `cause` field of this `SOAPException` object with the given `Throwable` object.

Field Detail

cause	back to summary
private Throwable cause Hides java.lang.Throwable.cause. The cause.

cause

back to summary

private Throwable cause

Hides java.lang.Throwable.cause.

The cause.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

SOAPException	back to summary
public SOAPException() Constructs a `SOAPException` object with no reason or embedded `Throwable` object.

SOAPException back to summary

SOAPException	back to summary
public SOAPException(String reason) Constructs a `SOAPException` object with the given `String` as the reason for the exception being thrown. Parameters reason:String a description of what caused the exception

public SOAPException(String reason)

Constructs a SOAPException object with the given String as the reason for the exception being thrown.

Parameters

reason:String: a description of what caused the exception

SOAPException back to summary

SOAPException	back to summary
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:String a description of what caused the exception cause:Throwable a `Throwable` object that is to be embedded in this `SOAPException` object

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:String: a description of what caused the exception
cause:Throwable: a Throwable object that is to be embedded in this SOAPException object

SOAPException back to summary

SOAPException	back to summary
public SOAPException(Throwable cause) Constructs a `SOAPException` object initialized with the given `Throwable` object. Parameters cause:Throwable a `Throwable` object that is to be embedded in this `SOAPException` object

public SOAPException(Throwable cause)

Constructs a SOAPException object initialized with the given Throwable object.

Parameters

cause:Throwable: a Throwable object that is to be embedded in this SOAPException object

Method Detail

getCause back to summary

getCause	back to summary
public Throwable getCause() Overrides java.lang.Throwable.getCause. Returns the `Throwable` object embedded in this `SOAPException` if there is one. Otherwise, this method returns `null`. Returns:Throwable the embedded `Throwable` object or `null` if there is none Annotations @Override

public Throwable getCause()

Overrides java.lang.Throwable.getCause.

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

Returns:Throwable

the embedded Throwable object or null if there is none

Annotations

@Override

getMessage back to summary

getMessage	back to summary
public String getMessage() Overrides java.lang.Throwable.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:String the error or warning message for this `SOAPException` or, if it has none, the message of the embedded `Throwable` object, if there is one Annotations @Override

public String getMessage()

Overrides java.lang.Throwable.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:String

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

Annotations

@Override

initCause back to summary

initCause	back to summary
public synchronized Throwable initCause(Throwable cause) Overrides java.lang.Throwable.initCause. 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. Parameters cause:Throwable 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. Returns:Throwable a reference to this `SOAPException` instance Annotations @Override Exceptions IllegalArgumentException: if `cause` is this `Throwable` object. (A `Throwable` object cannot be its own cause.) IllegalStateException: if the cause for this `SOAPException` object has already been initialized

public synchronized Throwable initCause(Throwable cause)

Overrides java.lang.Throwable.initCause.

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.

Parameters

cause:Throwable: 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.

Returns:Throwable

a reference to this SOAPException instance

Annotations

@Override

Exceptions

IllegalArgumentException:: if cause is this Throwable object. (A Throwable object cannot be its own cause.)
IllegalStateException:: if the cause for this SOAPException object has already been initialized

public Class SOAPException

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail