org.opensaml.provider
Class SOAPHTTPBindingProvider

java.lang.Object
  org.opensaml.SOAPBinding
      org.opensaml.provider.SOAPHTTPBindingProvider

All Implemented Interfaces:

SAMLBinding, SAMLSOAPBinding, SAMLSOAPHTTPBinding

public class SOAPHTTPBindingProvider
extends SOAPBinding
implements SAMLSOAPHTTPBinding

SOAP over HTTP binding implementation. The following properties can be placed in the OpenSAML configuration file to enable SSL client-certificate authentication with the server.

• org.opensaml.ssl.keystore - path to the store that contains the client's key and certificate
• org.opensaml.ssl.keystore-pwd - the password to the keystore
• org.opensaml.ssl.key-pwd - the passphrase to the private key in the keystore
• org.opensaml.ssl.keystore-type - the key store type, defaults to JKS if not set
• org.opensaml.ssl.truststore - path to the store that contains the server/CA certs needed to validate the cert chain
• org.opensaml.ssl.truststore-pwd - the password to the trust store
• org.opensaml.ssl.truststore-type - the trust store type, defaults to JKS if not set

Notes:

• If the org.opensaml.ssl.keystore property is set the remaing *key* properties must also be set.
• If the org.opensaml.ssl.truststore property is set the remaing *trust* properties must also be set.
• The private key MUST be passphrase protected.
• The properties described above apply to ALL instances of this binding within a given VM.

Author:

Scott Cantor

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.SAMLSOAPHTTPBinding

SAMLSOAPHTTPBinding.HTTPHook

Nested classes/interfaces inherited from interface org.opensaml.SAMLSOAPBinding

SAMLSOAPBinding.SOAPHook

Field Summary

Fields inherited from interface org.opensaml.SAMLBinding

SAML_SOAP_HTTPS, SOAP

Constructor Summary

SOAPHTTPBindingProvider(String binding, Element e)
Defeault constructor for a SAMLSOAPBinding object

Method Summary

void	addHook(SAMLSOAPHTTPBinding.HTTPHook h) Attach an HTTP hook.
void	addHook(SAMLSOAPHTTPBinding.HTTPHook h, Object globalCtx) Attach an HTTP hook.
SAMLRequest	receive(Object reqContext, int minor) Used by responder to process the receipt of a SAML request
SAMLRequest	receive(Object reqContext, Object callCtx, int minor) Used by responder to process the receipt of a SAML request, with hook context
void	respond(Object respContext, SAMLResponse response, SAMLException e) Return a response or fault to a requester
void	respond(Object respContext, SAMLResponse response, SAMLException e, Object callCtx) Return a response or fault to a requester with hook context
SAMLResponse	send(String endpoint, SAMLRequest request) Used by requester to send a SAML request to an authority, and obtain a response in return
SAMLResponse	send(String endpoint, SAMLRequest request, Object callCtx) Used by requester to send a SAML request to an authority, and obtain a response in return, with hook context

Methods inherited from class org.opensaml.SOAPBinding

addHook, addHook, recvRequest, recvResponse, sendRequest, sendResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.SAMLSOAPBinding

addHook, addHook, recvRequest, recvResponse, sendRequest, sendResponse

Constructor Detail

SOAPHTTPBindingProvider

public SOAPHTTPBindingProvider(String binding,
                               Element e)
                        throws SAMLException

Defeault constructor for a SAMLSOAPBinding object

Throws:

SAMLException

Method Detail

addHook

public void addHook(SAMLSOAPHTTPBinding.HTTPHook h)

Description copied from interface: SAMLSOAPHTTPBinding

Attach an HTTP hook.

Specified by:

addHook in interface SAMLSOAPHTTPBinding

Parameters:

h - Hook interface to attach

See Also:

SAMLSOAPHTTPBinding.addHook(org.opensaml.SAMLSOAPHTTPBinding.HTTPHook)

addHook

public void addHook(SAMLSOAPHTTPBinding.HTTPHook h,
                    Object globalCtx)

Description copied from interface: SAMLSOAPHTTPBinding

Attach an HTTP hook.

Specified by:

addHook in interface SAMLSOAPHTTPBinding

Parameters:

h - Hook interface to attach

globalCtx - Context data to pass to registered hooks

See Also:

SAMLSOAPHTTPBinding.addHook(org.opensaml.SAMLSOAPHTTPBinding.HTTPHook, java.lang.Object)

send

public SAMLResponse send(String endpoint,
                         SAMLRequest request,
                         Object callCtx)
                  throws SAMLException

Description copied from interface: SAMLBinding

Used by requester to send a SAML request to an authority, and obtain a response in return, with hook context

Specified by:

send in interface SAMLBinding

Parameters:

endpoint - Defines the endpoint to communicate with

request - SAML request to send

callCtx - Context data to pass to registered hooks for this call

Returns:

SAML response received from authority

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.send(java.lang.String, org.opensaml.SAMLRequest, java.lang.Object)

receive

public SAMLRequest receive(Object reqContext,
                           Object callCtx,
                           int minor)
                    throws SAMLException

Description copied from interface: SAMLBinding

Used by responder to process the receipt of a SAML request, with hook context

Specified by:

receive in interface SAMLBinding

Parameters:

reqContext - A generic placeholder for binding-specific request context

callCtx - Context data to pass to registered hooks for this call

Returns:

A SAML request

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.receive(java.lang.Object, java.lang.Object, int)

respond

public void respond(Object respContext,
                    SAMLResponse response,
                    SAMLException e,
                    Object callCtx)
             throws SAMLException

Description copied from interface: SAMLBinding

Return a response or fault to a requester with hook context

Specified by:

respond in interface SAMLBinding

Parameters:

respContext - A generic placeholder for binding-specific response context

response - The SAML response to return (optional)

e - An exception to translate into a binding fault (optional)

callCtx - Context data to pass to registered hooks for this call

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.respond(java.lang.Object, org.opensaml.SAMLResponse, org.opensaml.SAMLException, java.lang.Object)

send

public SAMLResponse send(String endpoint,
                         SAMLRequest request)
                  throws SAMLException

Description copied from interface: SAMLBinding

Used by requester to send a SAML request to an authority, and obtain a response in return

Specified by:

send in interface SAMLBinding

Parameters:

endpoint - Defines the endpoint to communicate with

request - SAML request to send

Returns:

SAML response received from authority

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.send(java.lang.String, org.opensaml.SAMLRequest)

receive

public SAMLRequest receive(Object reqContext,
                           int minor)
                    throws SAMLException

Description copied from interface: SAMLBinding

Used by responder to process the receipt of a SAML request

Specified by:

receive in interface SAMLBinding

Parameters:

reqContext - A generic placeholder for binding-specific request context

minor - Minor version to support

Returns:

A SAML request

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.receive(java.lang.Object, int)

respond

public void respond(Object respContext,
                    SAMLResponse response,
                    SAMLException e)
             throws SAMLException

Description copied from interface: SAMLBinding

Return a response or fault to a requester

Specified by:

respond in interface SAMLBinding

Parameters:

respContext - A generic placeholder for binding-specific response context

response - The SAML response to return (optional)

e - An exception to translate into a binding fault (optional)

Throws:

SAMLException - Base class of exceptions that may be thrown during processing

See Also:

SAMLBinding.respond(java.lang.Object, org.opensaml.SAMLResponse, org.opensaml.SAMLException)