SOAPException (Axis API)
Keywords: javax.xml.soap.SOAPException class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.xml.soap
Class SOAPException

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

All Implemented Interfaces:
  java.io.Serializable

public class SOAPException
extends java.lang.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

Constructor Summary
`SOAPException()` Constructs a `SOAPException` object with no reason or embedded `Throwable` object.
`SOAPException(java.lang.String reason)` Constructs a `SOAPException` object with the given `String` as the reason for the exception being thrown.
`SOAPException(java.lang.String reason, java.lang.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(java.lang.Throwable cause)` Constructs a `SOAPException` object initialized with the given `Throwable` object.

Method Summary
`java.lang.Throwable` | `getCause()` Returns the `Throwable` object embedded in this `SOAPException` if there is one.
`java.lang.String` | `getMessage()` Returns the detail message for this `SOAPException` object.
`java.lang.Throwable` | `initCause(java.lang.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`

Constructor Detail

### SOAPException

    public SOAPException()

  Constructs a `SOAPException` object with no reason or embedded `Throwable` object.

### SOAPException

    public SOAPException(java.lang.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(java.lang.String reason,
                         java.lang.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(java.lang.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 Detail

### getMessage

    public java.lang.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

### getCause

    public java.lang.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

### initCause

    public java.lang.Throwable initCause(java.lang.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.

  Parameters:
    `cause` - 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:
    a reference to this `SOAPException` instance
  Throws:
    `java.lang.IllegalArgumentException` - if `cause` is this `Throwable` object. (A `Throwable` object cannot be its own cause.)
    `java.lang.IllegalStateException` - if this `SOAPException` object was created with `SOAPException(java.lang.Throwable)` or `SOAPException(java.lang.String, java.lang.Throwable)`, or this method has already been called on this `SOAPException` object

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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