org.picketlink.identity.federation.web.handlers.saml2

Class BaseSAML2Handler

java.lang.Object

org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

All Implemented Interfaces:

SAML2Handler

Direct Known Subclasses:

AbstractSignatureHandler, RolesGenerationHandler, SAML2AttributeHandler, SAML2AuthenticationHandler, SAML2InResponseToVerificationHandler, SAML2IssuerTrustHandler, SAML2LogOutHandler

public abstract class BaseSAML2Handler
extends Object
implements SAML2Handler

Base Class for SAML2 handlers

Since:

Oct 7, 2009

Author:

Anil.Saldhana@redhat.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2Handler

SAML2Handler.HANDLER_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
protected SAML2HandlerChainConfig	handlerChainConfig
protected SAML2HandlerConfig	handlerConfig
protected static PicketLinkLogger	logger

Fields inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2Handler

ASSERTION_CONSUMER_URL, CLOCK_SKEW_MILIS, DISABLE_AUTHN_STATEMENT, DISABLE_ROLE_PICKING, DISABLE_SENDING_ROLES, ROLE_KEY, USE_MULTI_VALUED_ROLES

Constructor Summary

Constructors

Constructor and Description
BaseSAML2Handler()

Method Summary

Modifier and Type	Method and Description
protected void	checkDestination(String destination, String expectedDestination)
protected void	checkDestination(URI destination, String expectedDestination)
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
static HttpServletRequest	getHttpRequest(SAML2HandlerRequest request)
static HttpSession	getHttpSession(SAML2HandlerRequest request)
protected ProviderType	getProviderconfig()
SAML2Handler.HANDLER_TYPE	getType() Get the type of handler - handler at IDP or SP
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
void	reset() Shed all state

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2Handler

handleRequestType

Field Detail

logger

protected static final PicketLinkLogger logger

handlerConfig

protected SAML2HandlerConfig handlerConfig

handlerChainConfig

protected SAML2HandlerChainConfig handlerChainConfig

Constructor Detail

BaseSAML2Handler

public BaseSAML2Handler()

Method Detail

initHandlerConfig

public void initHandlerConfig(SAML2HandlerConfig handlerConfig)
                       throws ConfigurationException

Initialize the handler

Specified by:

initHandlerConfig in interface SAML2Handler

Parameters:

options -

Throws:

ConfigurationException

initChainConfig

public void initChainConfig(SAML2HandlerChainConfig handlerChainConfig)
                     throws ConfigurationException

Description copied from interface: SAML2Handler

Initialize the handler

Specified by:

initChainConfig in interface SAML2Handler

Throws:

ConfigurationException

getType

public SAML2Handler.HANDLER_TYPE getType()

Get the type of handler - handler at IDP or SP

Specified by:

getType in interface SAML2Handler

Returns:

reset

public void reset()
           throws ProcessingException

Description copied from interface: SAML2Handler

Shed all state

Specified by:

reset in interface SAML2Handler

Throws:

ProcessingException

generateSAMLRequest

public void generateSAMLRequest(SAML2HandlerRequest request,
                                SAML2HandlerResponse response)
                         throws ProcessingException

Description copied from interface: SAML2Handler

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

Specified by:

generateSAMLRequest in interface SAML2Handler

Throws:

ProcessingException

See Also:

SAML2Handler.generateSAMLRequest(SAML2HandlerRequest, SAML2HandlerResponse)

handleStatusResponseType

public void handleStatusResponseType(SAML2HandlerRequest request,
                                     SAML2HandlerResponse response)
                              throws ProcessingException

Description copied from interface: SAML2Handler

Handle a SAML2 Status Response Type

Specified by:

handleStatusResponseType in interface SAML2Handler

Throws:

ProcessingException

See Also:

SAML2Handler#handleStatusResponseType(SAML2HandlerRequest, SAML2HandlerResponse)}

getHttpRequest

public static HttpServletRequest getHttpRequest(SAML2HandlerRequest request)

getHttpSession

public static HttpSession getHttpSession(SAML2HandlerRequest request)

getProviderconfig

protected ProviderType getProviderconfig()

checkDestination

protected void checkDestination(String destination,
                                String expectedDestination)
                         throws ProcessingException

Throws:

ProcessingException

checkDestination

protected void checkDestination(URI destination,
                                String expectedDestination)
                         throws ProcessingException

Throws:

ProcessingException