org.opensaml
Interface SAMLBinding

All Known Subinterfaces:
SAMLSOAPBinding, SAMLSOAPHTTPBinding
All Known Implementing Classes:
SOAPBinding, SOAPHTTPBindingProvider

public interface SAMLBinding

Interface to generic SAML binding implementations. The setVersion method should not be called without synchronization, but binding implementations must be threadsafe with respect to the actual binding operations.

Author:
Scott Cantor

Field Summary
static String SAML_SOAP_HTTPS
          Deprecated. Deprecated constant name for SAML SOAP binding protocol
static String SOAP
          SAML SOAP binding protocol
 
Method Summary
 SAMLRequest receive(Object reqContext, int minorVersion)
          Used by responder to process the receipt of a SAML request
 SAMLRequest receive(Object reqContext, Object callCtx, int minorVersion)
          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
 

Field Detail

SOAP

static final String SOAP
SAML SOAP binding protocol

See Also:
Constant Field Values

SAML_SOAP_HTTPS

static final String SAML_SOAP_HTTPS
Deprecated. Deprecated constant name for SAML SOAP binding protocol
See Also:
Constant Field Values
Method Detail

send

SAMLResponse send(String endpoint,
                  SAMLRequest request,
                  Object callCtx)
                  throws SAMLException
Used by requester to send a SAML request to an authority, and obtain a response in return, with hook context

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

send

SAMLResponse send(String endpoint,
                  SAMLRequest request)
                  throws SAMLException
Used by requester to send a SAML request to an authority, and obtain a response in return

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

receive

SAMLRequest receive(Object reqContext,
                    Object callCtx,
                    int minorVersion)
                    throws SAMLException
Used by responder to process the receipt of a SAML request, with hook context

Parameters:
reqContext - A generic placeholder for binding-specific request context
callCtx - Context data to pass to registered hooks for this call
minorversion - Minor version to support
Returns:
A SAML request
Throws:
SAMLException - Base class of exceptions that may be thrown during processing

receive

SAMLRequest receive(Object reqContext,
                    int minorVersion)
                    throws SAMLException
Used by responder to process the receipt of a SAML request

Parameters:
reqContext - A generic placeholder for binding-specific request context
minorVersion - Minor version to support
Returns:
A SAML request
Throws:
SAMLException - Base class of exceptions that may be thrown during processing

respond

void respond(Object respContext,
             SAMLResponse response,
             SAMLException e,
             Object callCtx)
             throws SAMLException
Return a response or fault to a requester with hook context

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

respond

void respond(Object respContext,
             SAMLResponse response,
             SAMLException e)
             throws SAMLException
Return a response or fault to a requester

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


Copyright ? 2005 UCAID. All Rights Reserved.