org.opensaml
Class SOAPBinding

java.lang.Object
  extended byorg.opensaml.SOAPBinding
All Implemented Interfaces:
SAMLBinding, SAMLSOAPBinding
Direct Known Subclasses:
SOAPHTTPBindingProvider

public abstract class SOAPBinding
extends Object
implements SAMLSOAPBinding

Implementation of SOAP binding packaging methods, useful as a base class for full binding implementations once a transport protocol is added by implementing the actual binding methods.

Author:
Scott Cantor

Nested Class Summary
 
Nested classes inherited from class org.opensaml.SAMLSOAPBinding
SAMLSOAPBinding.SOAPHook
 
Field Summary
 
Fields inherited from interface org.opensaml.SAMLBinding
SAML_SOAP_HTTPS, SOAP
 
Constructor Summary
SOAPBinding()
           
 
Method Summary
 void addHook(SAMLSOAPBinding.SOAPHook h)
          Attach a SOAP hook.
 void addHook(SAMLSOAPBinding.SOAPHook h, Object globalCtx)
          Attach a SOAP hook.
 SAMLRequest recvRequest(Element envelope, Object callCtx)
          Unpacks a SAML request from a SOAP envelope
 SAMLResponse recvResponse(Element envelope, Object callCtx)
          Unpacks a SAML response from a SOAP envelope
 Element sendRequest(SAMLRequest request, Object callCtx)
          Packages a SAML request for transmission via SOAP
 Element sendResponse(SAMLResponse response, SAMLException e, Object callCtx)
          Packages a SAML response for transmission via SOAP
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensaml.SAMLBinding
receive, receive, respond, respond, send, send
 

Constructor Detail

SOAPBinding

public SOAPBinding()
Method Detail

addHook

public void addHook(SAMLSOAPBinding.SOAPHook h)
Description copied from interface: SAMLSOAPBinding
Attach a SOAP hook.

Specified by:
addHook in interface SAMLSOAPBinding
Parameters:
h - Hook interface to attach
See Also:
SAMLSOAPBinding.addHook(org.opensaml.SAMLSOAPBinding.SOAPHook)

addHook

public void addHook(SAMLSOAPBinding.SOAPHook h,
                    Object globalCtx)
Description copied from interface: SAMLSOAPBinding
Attach a SOAP hook.

Specified by:
addHook in interface SAMLSOAPBinding
Parameters:
h - Hook interface to attach
globalCtx - Context data to pass to registered hooks on each call
See Also:
SAMLSOAPBinding.addHook(org.opensaml.SAMLSOAPBinding.SOAPHook, java.lang.Object)

sendRequest

public Element sendRequest(SAMLRequest request,
                           Object callCtx)
                    throws SAMLException
Description copied from interface: SAMLSOAPBinding
Packages a SAML request for transmission via SOAP

Specified by:
sendRequest in interface SAMLSOAPBinding
Parameters:
request - The SAML request to prepare
callCtx - Context data to pass to registered hooks for this call
Returns:
A SOAP envelope compliant with the SOAP binding
Throws:
SAMLException - Raised if an error occurs in preparing the SOAP message
See Also:
SAMLSOAPBinding.sendRequest(org.opensaml.SAMLRequest, java.lang.Object)

recvResponse

public SAMLResponse recvResponse(Element envelope,
                                 Object callCtx)
                          throws SAMLException
Description copied from interface: SAMLSOAPBinding
Unpacks a SAML response from a SOAP envelope

Specified by:
recvResponse in interface SAMLSOAPBinding
Parameters:
envelope - The SOAP envelope received
callCtx - Context data to pass to registered hooks for this call
Returns:
The SAML response received
Throws:
SAMLException - Raised if the SAML response cannot be unpacked successfully or if it contains an error
See Also:
SAMLSOAPBinding.recvResponse(org.w3c.dom.Element, java.lang.Object)

recvRequest

public SAMLRequest recvRequest(Element envelope,
                               Object callCtx)
                        throws SAMLException
Description copied from interface: SAMLSOAPBinding
Unpacks a SAML request from a SOAP envelope

Specified by:
recvRequest in interface SAMLSOAPBinding
Parameters:
envelope - The SOAP envelope received
callCtx - Context data to pass to registered hooks for this call
Returns:
The SAML request received
Throws:
SAMLException - Raised if the SAML request cannot be unpacked successfully
See Also:
SAMLSOAPBinding.recvRequest(org.w3c.dom.Element, java.lang.Object)

sendResponse

public Element sendResponse(SAMLResponse response,
                            SAMLException e,
                            Object callCtx)
                     throws SAMLException
Description copied from interface: SAMLSOAPBinding
Packages a SAML response for transmission via SOAP

Specified by:
sendResponse in interface SAMLSOAPBinding
Parameters:
response - The SAML response to prepare (may be null)
e - An exception to package for transmission as a SOAP fault
callCtx - Context data to pass to registered hooks for this call
Returns:
A SOAP envelope compliant with the SOAP binding
Throws:
SAMLException - Raised if an error occurs in preparing the SOAP message
See Also:
SAMLSOAPBinding.sendResponse(org.opensaml.SAMLResponse, org.opensaml.SAMLException, java.lang.Object)


Copyright ? 2005 UCAID. All Rights Reserved.