org.opensaml
Class SOAPException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.opensaml.SAMLException
              extended byorg.opensaml.BindingException
                  extended byorg.opensaml.SOAPException
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOAPException
extends BindingException
implements java.lang.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 QName CLIENT
          SOAP Client fault code
static QName MUSTUNDERSTAND
          SOAP MustUnderstand fault code
static QName SERVER
          SOAP Server fault code
static QName VERSION
          SOAP Version Mismatch status code
 
Fields inherited from class org.opensaml.SAMLException
codes, config, e, log, msg, REQUESTER, RESPONDER, root, SUCCESS
 
Constructor Summary
  SOAPException(java.util.Collection codes, java.lang.Exception e)
          Creates a new SOAPException wrapping an existing exception
  SOAPException(java.util.Collection codes, java.lang.String msg)
          Creates a new SOAPException
  SOAPException(java.util.Collection codes, java.lang.String msg, java.lang.Exception e)
          Creates a new SOAPException from an existing exception.
protected SOAPException(org.w3c.dom.Element e)
          Creates a new SOAPException
  SOAPException(QName code, java.lang.Exception e)
          Creates a new SOAPException wrapping an existing exception
  SOAPException(QName code, java.lang.String msg)
          Creates a new SOAPException
  SOAPException(QName code, java.lang.String msg, java.lang.Exception e)
          Creates a new SOAPException from an existing exception.
  SOAPException(java.lang.String msg)
          Creates a new SOAPException
  SOAPException(java.lang.String msg, java.lang.Exception e)
          Creates a new SOAPException
 
Method Summary
 void fromDOM(org.w3c.dom.Element e)
          Handles initialization of exceptions from a DOM element
 org.w3c.dom.Node toDOM(org.w3c.dom.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, 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 QName CLIENT
SOAP Client fault code


SERVER

public static final QName SERVER
SOAP Server fault code


MUSTUNDERSTAND

public static final QName MUSTUNDERSTAND
SOAP MustUnderstand fault code


VERSION

public static final QName VERSION
SOAP Version Mismatch status code

Constructor Detail

SOAPException

protected SOAPException(org.w3c.dom.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(java.lang.String msg)
Creates a new SOAPException

Parameters:
msg - The detail message

SOAPException

public SOAPException(java.lang.String msg,
                     java.lang.Exception e)
Creates a new SOAPException

Parameters:
msg - The detail message
e - The exception to be wrapped in a SOAPException

SOAPException

public SOAPException(java.util.Collection codes,
                     java.lang.String msg)
Creates a new SOAPException

Parameters:
codes - A collection of QNames
msg - The detail message

SOAPException

public SOAPException(java.util.Collection codes,
                     java.lang.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(java.util.Collection codes,
                     java.lang.String msg,
                     java.lang.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(QName code,
                     java.lang.String msg)
Creates a new SOAPException

Parameters:
code - A status code
msg - The detail message

SOAPException

public SOAPException(QName code,
                     java.lang.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(QName code,
                     java.lang.String msg,
                     java.lang.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(org.w3c.dom.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 org.w3c.dom.Node toDOM(org.w3c.dom.Document doc)
                       throws org.w3c.dom.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:
org.w3c.dom.DOMException - Raised if an XML exception is detected


Copyright ? 2002 UCAID. All Rights Reserved.