org.picketlink.identity.federation.core.saml.v2.interfaces

Interface SAML2Handler

All Known Implementing Classes:

AbstractSignatureHandler, BaseSAML2Handler, RolesGenerationHandler, SAML2AttributeHandler, SAML2AuthenticationHandler, SAML2EncryptionHandler, SAML2InResponseToVerificationHandler, SAML2IssuerTrustHandler, SAML2LogOutHandler, SAML2SignatureGenerationHandler, SAML2SignatureValidationHandler

public interface SAML2Handler

Handle SAML2 Request types and status response types

Since:

Sep 17, 2009

Author:

Anil.Saldhana@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SAML2Handler.HANDLER_TYPE Processing Point - idp side or service side

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSERTION_CONSUMER_URL
static String	CLOCK_SKEW_MILIS
static String	DISABLE_AUTHN_STATEMENT
static String	DISABLE_ROLE_PICKING
static String	DISABLE_SENDING_ROLES
static String	ROLE_KEY
static String	USE_MULTI_VALUED_ROLES

Method Summary

Modifier and Type	Method and Description
void	generateSAMLRequest(SAML2HandlerRequest request, SAML2HandlerResponse response) Generate a SAML Request to be sent to the IDP if the handler is invoked at the SP and vice-versa
SAML2Handler.HANDLER_TYPE	getType() Get the type of handler - handler at IDP or SP
void	handleRequestType(SAML2HandlerRequest request, SAML2HandlerResponse response) Handle a SAML2 RequestAbstractType
void	handleStatusResponseType(SAML2HandlerRequest request, SAML2HandlerResponse response) Handle a SAML2 Status Response Type
void	initChainConfig(SAML2HandlerChainConfig handlerChainConfig) Initialize the handler
void	initHandlerConfig(SAML2HandlerConfig handlerConfig) Initialize the handler from configuration
void	reset() Shed all state

Field Detail

ASSERTION_CONSUMER_URL

static final String ASSERTION_CONSUMER_URL

See Also:

Constant Field Values

CLOCK_SKEW_MILIS

static final String CLOCK_SKEW_MILIS

See Also:

Constant Field Values

DISABLE_AUTHN_STATEMENT

static final String DISABLE_AUTHN_STATEMENT

See Also:

Constant Field Values

DISABLE_SENDING_ROLES

static final String DISABLE_SENDING_ROLES

See Also:

Constant Field Values

DISABLE_ROLE_PICKING

static final String DISABLE_ROLE_PICKING

See Also:

Constant Field Values

USE_MULTI_VALUED_ROLES

static final String USE_MULTI_VALUED_ROLES

See Also:

Constant Field Values

ROLE_KEY

static final String ROLE_KEY

See Also:

Constant Field Values

Method Detail

initChainConfig

void initChainConfig(SAML2HandlerChainConfig handlerChainConfig)
              throws ConfigurationException

Initialize the handler

Parameters:

handlerConfig - Handler Config

Throws:

ConfigurationException

initHandlerConfig

void initHandlerConfig(SAML2HandlerConfig handlerConfig)
                throws ConfigurationException

Initialize the handler from configuration

Parameters:

options -

Throws:

ConfigurationException

generateSAMLRequest

void generateSAMLRequest(SAML2HandlerRequest request,
                         SAML2HandlerResponse response)
                  throws ProcessingException

Generate a SAML Request to be sent to the IDP if the handler is invoked at the SP and vice-versa

Parameters:

request -

response -

Throws:

ProcessingException

getType

SAML2Handler.HANDLER_TYPE getType()

Get the type of handler - handler at IDP or SP

Returns:

handleRequestType

void handleRequestType(SAML2HandlerRequest request,
                       SAML2HandlerResponse response)
                throws ProcessingException

Handle a SAML2 RequestAbstractType

Parameters:

requestAbstractType -

resultingDocument -

Throws:

ProcessingException

handleStatusResponseType

void handleStatusResponseType(SAML2HandlerRequest request,
                              SAML2HandlerResponse response)
                       throws ProcessingException

Handle a SAML2 Status Response Type

Parameters:

statusResponseType -

resultingDocument -

Throws:

ProcessingException

reset

void reset()
    throws ProcessingException

Shed all state

Throws:

ProcessingException