Package com.sun.xml.messaging.saaj

Class SOAPExceptionImpl

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    SOAPVersionMismatchException
    public class SOAPExceptionImpl
extends jakarta.xml.soap.SOAPException
    An exception that signals that a SOAP exception has occurred. A SOAPExceptionImpl 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 SOAPExceptionImpl 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 Detail

      • SOAPExceptionImpl

        public SOAPExceptionImpl()
        Constructs a SOAPExceptionImpl object with no reason or embedded Throwable object.

      • SOAPExceptionImpl

        public SOAPExceptionImpl​(String reason)
        Constructs a SOAPExceptionImpl object with the given String as the reason for the exception being thrown.
        Parameters:
        reason - a description of what caused the exception

      • SOAPExceptionImpl

        public SOAPExceptionImpl​(String reason,
                         Throwable cause)
        Constructs a SOAPExceptionImpl 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 SOAPExceptionImpl object

      • SOAPExceptionImpl

        public SOAPExceptionImpl​(Throwable cause)
        Constructs a SOAPExceptionImpl object initialized with the given Throwable object.
        Parameters:
        cause - cause

    • Method Detail

      • getMessage

        public String getMessage()
        Returns the detail message for this SOAPExceptionImpl object.

        If there is an embedded Throwable object, and if the SOAPExceptionImpl object has no detail message of its own, this method will return the detail message from the embedded Throwable object.

        Overrides:
        getMessage in class jakarta.xml.soap.SOAPException
        Returns:
        the error or warning message for this SOAPExceptionImpl 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 this SOAPExceptionImpl if there is one. Otherwise, this method returns null.
        Overrides:
        getCause in class jakarta.xml.soap.SOAPException
        Returns:
        the embedded Throwable object or null if there is none

      • initCause

        public Throwable initCause​(Throwable cause)
        Initializes the cause field of this SOAPExceptionImpl 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 SOAPExceptionImpl object. If this SOAPExceptionImpl object was created with the constructor SOAPExceptionImpl(Throwable) or SOAPExceptionImpl(String,Throwable), meaning that its cause field already has a value, this method cannot be called even once.

        Overrides:
        initCause in class jakarta.xml.soap.SOAPException
        Parameters:
        cause - the Throwable object that caused this SOAPExceptionImpl 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 SOAPExceptionImpl instance
        Throws:
        IllegalArgumentException - if cause is this Throwable object. (A Throwable object cannot be its own cause.)
        IllegalStateException - if this SOAPExceptionImpl object was created with SOAPExceptionImpl(Throwable) or SOAPExceptionImpl(String,Throwable), or this method has already been called on this SOAPExceptionImpl object