org.opensaml
Interface SAMLBinding

All Known Implementing Classes:
SAMLSOAPBinding

public interface SAMLBinding

Abstract base for SAML binding implementations

Author:
Scott Cantor

Field Summary
static java.lang.String SAML_SOAP_HTTPS
          SAML SOAP over HTTPS binding protocol
 
Method Summary
 SAMLRequest receive(java.lang.Object reqContext)
          Used by responder to process the receipt of a SAML request
 SAMLRequest receive(java.lang.Object reqContext, java.lang.StringBuffer requester)
          Deprecated.  
 void respond(java.lang.Object respContext, SAMLResponse response, SAMLException e)
          Return a response to a requester
 SAMLResponse send(SAMLAuthorityBinding bindingInfo, SAMLRequest request)
          Used by requester to send a SAML request to an authority, and obtain a response in return
 

Field Detail

SAML_SOAP_HTTPS

public static final java.lang.String SAML_SOAP_HTTPS
SAML SOAP over HTTPS binding protocol

See Also:
Constant Field Values
Method Detail

send

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

Parameters:
bindingInfo - Defines the binding protocol and the authority to contact
request - SAML request to send
Returns:
SAML response received from authority
Throws:
SAMLException - Base class of exceptions that may be thrown during processing

receive

public SAMLRequest receive(java.lang.Object reqContext,
                           java.lang.StringBuffer requester)
                    throws SAMLException
Deprecated.  

Used by responder to process the receipt of a SAML request

Parameters:
reqContext - A generic placeholder for binding-specific request context
requester - The authenticated name of the requester, if possible to determine from the binding
Returns:
A SAML request
Throws:
SAMLException - Base class of exceptions that may be thrown during processing

receive

public SAMLRequest receive(java.lang.Object reqContext)
                    throws SAMLException
Used by responder to process the receipt of a SAML request

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

respond

public void respond(java.lang.Object respContext,
                    SAMLResponse response,
                    SAMLException e)
             throws java.io.IOException
Return a response 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:
java.io.IOException - Thrown if sending of data fails


Copyright ? 2002 UCAID. All Rights Reserved.