IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.webservices.soap
Class SOAPException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by java.rmi.RemoteException
                  extended by com.ibm.websphere.webservices.soap.SOAPException
All Implemented Interfaces:
java.io.Serializable

public abstract class SOAPException
extends java.rmi.RemoteException

A SOAPException is a Remote Exception representing the information of the SOAPFault. The SOAPException may represent a System exception or an Application exception.

See Also:
RemoteException, Serialized Form

Field Summary
 
Fields inherited from class java.rmi.RemoteException
detail
 
Constructor Summary
protected SOAPException()
           
protected SOAPException(java.lang.String message)
           
protected SOAPException(java.lang.String message, java.lang.Throwable t)
           
 
Method Summary
abstract  java.lang.Exception getApplicationException()
          Returns the user-defined exception associated with this SOAPException.
abstract  java.lang.String getFaultActor()
           
abstract  javax.xml.namespace.QName getFaultCode()
           
abstract  java.lang.String getFaultReason()
           
abstract  java.lang.String getFaultReturnCode()
           
abstract  java.lang.String getFaultString()
           
abstract  java.lang.String getMessage()
           
abstract  boolean isApplicationException()
          Determines if this is a user-defined exception.
 
Methods inherited from class java.rmi.RemoteException
getCause
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, 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

protected SOAPException()

SOAPException

protected SOAPException(java.lang.String message)

SOAPException

protected SOAPException(java.lang.String message,
                        java.lang.Throwable t)
Method Detail

isApplicationException

public abstract boolean isApplicationException()
Determines if this is a user-defined exception. A user-defined exception is one that is described in the WSDL for a given operation and is thrown by the service endpoint.

Returns:
true if the SOAPException represents a user-defined exception.

getApplicationException

public abstract java.lang.Exception getApplicationException()
Returns the user-defined exception associated with this SOAPException.

Returns:
the user-defined exception or null if this SOAPException is not a user-defined exception.

getFaultCode

public abstract javax.xml.namespace.QName getFaultCode()
Returns:
the faultCode associated with this SOAPException in the form of a QName

getFaultString

public abstract java.lang.String getFaultString()
Returns:
the faultString associated with this SOAPException

getFaultActor

public abstract java.lang.String getFaultActor()
Returns:
the faultActor associated with this SOAPException

getFaultReturnCode

public abstract java.lang.String getFaultReturnCode()
Returns:
the fault return code as a String

getFaultReason

public abstract java.lang.String getFaultReason()
Returns:
the fault reason associated with this SOAPException

getMessage

public abstract java.lang.String getMessage()
Overrides:
getMessage in class java.rmi.RemoteException
Returns:
the error message (fault details) associated with this SOAPException

IBM WebSphere Application ServerTM
Release 7