org.opensaml
Class SOAPException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.opensaml.SAMLException
              org.opensaml.BindingException
                  org.opensaml.SOAPException

All Implemented Interfaces:

Serializable, Cloneable

public class SOAPException
extends BindingException
implements Cloneable

Indicates that a SOAP processing error occurred in the context of the SAML SOAP binding. This subclass signals a binding implementation to return a SOAP fault instead of a SAML error.

Author:

Scott Cantor

See Also:

Serialized Form

Field Summary

static javax.xml.namespace.QName	CLIENT SOAP Client fault code
static javax.xml.namespace.QName	MUSTUNDERSTAND SOAP MustUnderstand fault code
static javax.xml.namespace.QName	SERVER SOAP Server fault code
static javax.xml.namespace.QName	VERSION SOAP Version Mismatch status code

Fields inherited from class org.opensaml.SAMLException

codes, config, e, log, msg, parentObject, REQUESTER, RESPONDER, root, SUCCESS

Constructor Summary

	SOAPException(Collection codes, Exception e) Creates a new SOAPException wrapping an existing exception
	SOAPException(Collection codes, String msg) Creates a new SOAPException
	SOAPException(Collection codes, String msg, Exception e) Creates a new SOAPException from an existing exception.
protected	SOAPException(Element e) Creates a new SOAPException
	SOAPException(javax.xml.namespace.QName code, Exception e) Creates a new SOAPException wrapping an existing exception
	SOAPException(javax.xml.namespace.QName code, String msg) Creates a new SOAPException
	SOAPException(javax.xml.namespace.QName code, String msg, Exception e) Creates a new SOAPException from an existing exception.
	SOAPException(String msg) Creates a new SOAPException
	SOAPException(String msg, Exception e) Creates a new SOAPException

Method Summary

void	fromDOM(Element e) Handles initialization of exceptions from a DOM element
Node	toDOM(Document doc) Transforms the object into a DOM tree using an existing document context

Methods inherited from class org.opensaml.SAMLException

clone, getCodes, getException, getInstance, getInstance, getMessage, getParent, setParent, toDOM, toDOM, toDOM, toStream, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLIENT

public static final javax.xml.namespace.QName CLIENT

SOAP Client fault code

SERVER

public static final javax.xml.namespace.QName SERVER

SOAP Server fault code

MUSTUNDERSTAND

public static final javax.xml.namespace.QName MUSTUNDERSTAND

SOAP MustUnderstand fault code

VERSION

public static final javax.xml.namespace.QName VERSION

SOAP Version Mismatch status code

Constructor Detail

SOAPException

protected SOAPException(Element e)
                 throws SAMLException

Creates a new SOAPException

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

SOAPException

public SOAPException(String msg)

Creates a new SOAPException

Parameters:

msg - The detail message

SOAPException

public SOAPException(String msg,
                     Exception e)

Creates a new SOAPException

Parameters:

msg - The detail message

e - The exception to be wrapped in a SOAPException

SOAPException

public SOAPException(Collection codes,
                     String msg)

Creates a new SOAPException

Parameters:

codes - A collection of QNames

msg - The detail message

SOAPException

public SOAPException(Collection codes,
                     Exception e)

Creates a new SOAPException wrapping an existing exception

The existing exception will be embedded in the new one, and its message will become the default message for the SOAPException.

Parameters:

codes - A collection of QNames

e - The exception to be wrapped in a SOAPException

SOAPException

public SOAPException(Collection codes,
                     String msg,
                     Exception e)

Creates a new SOAPException from an existing exception.

The existing exception will be embedded in the new one, but the new exception will have its own message.

Parameters:

codes - A collection of QNames

msg - The detail message

e - The exception to be wrapped in a SOAPException

SOAPException

public SOAPException(javax.xml.namespace.QName code,
                     String msg)

Creates a new SOAPException

Parameters:

code - A status code

msg - The detail message

SOAPException

public SOAPException(javax.xml.namespace.QName code,
                     Exception e)

Creates a new SOAPException wrapping an existing exception

The existing exception will be embedded in the new one, and its message will become the default message for the SOAPException.

Parameters:

code - A status code

e - The exception to be wrapped in a SOAPException

SOAPException

public SOAPException(javax.xml.namespace.QName code,
                     String msg,
                     Exception e)

Creates a new SOAPException from an existing exception.

The existing exception will be embedded in the new one, but the new exception will have its own message.

Parameters:

code - A status code

msg - The detail message

e - The exception to be wrapped in a SOAPException

Method Detail

fromDOM

public void fromDOM(Element e)
             throws SAMLException

Handles initialization of exceptions from a DOM element

Overrides:

fromDOM in class SAMLException

Parameters:

e -

Throws:

SAMLException - Raised if an exception occurs while initializing the object

toDOM

public Node toDOM(Document doc)
           throws DOMException

Transforms the object into a DOM tree using an existing document context

Overrides:

toDOM in class SAMLException

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root element node of the DOM tree capturing the object

Throws:

DOMException - Raised if an XML exception is detected