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

Class SAML2AttributeHandler

java.lang.Object

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

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

All Implemented Interfaces:

SAML2Handler

public class SAML2AttributeHandler
extends BaseSAML2Handler

Handler dealing with attributes for SAML2

Configuration for handler:

• ATTRIBUTE_MANAGER: a fqn of the attribute manager class. This is an IDP setting.
• ATTRIBUTE_KEYS: a comma separated list of string values representing attributes to be sent. IDP setting.
• ATTRIBUTE_CHOOSE_FRIENDLY_NAME : set to true if you require attributes to be keyed by friendly name rather than default name. SP Setting.

Since:

Oct 12, 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 AttributeManager	attribManager
protected List<String>	attributeKeys
protected boolean	chooseFriendlyName

Fields inherited from class org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

handlerChainConfig, handlerConfig, 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
SAML2AttributeHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	handleIDPResponse(SAML2HandlerRequest request)
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

Methods inherited from class org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

generateSAMLRequest, getHttpRequest, getHttpSession, getProviderconfig, getType, reset

Methods inherited from class java.lang.Object

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

Field Detail

attribManager

protected AttributeManager attribManager

attributeKeys

protected List<String> attributeKeys

chooseFriendlyName

protected boolean chooseFriendlyName

Constructor Detail

SAML2AttributeHandler

public SAML2AttributeHandler()

Method Detail

initChainConfig

public void initChainConfig(SAML2HandlerChainConfig handlerChainConfig)
                     throws org.picketlink.common.exceptions.ConfigurationException

Description copied from interface: SAML2Handler

Initialize the handler

Specified by:

initChainConfig in interface SAML2Handler

Overrides:

initChainConfig in class BaseSAML2Handler

Throws:

org.picketlink.common.exceptions.ConfigurationException

initHandlerConfig

public void initHandlerConfig(SAML2HandlerConfig handlerConfig)
                       throws org.picketlink.common.exceptions.ConfigurationException

Description copied from class: BaseSAML2Handler

Initialize the handler

Specified by:

initHandlerConfig in interface SAML2Handler

Overrides:

initHandlerConfig in class BaseSAML2Handler

Throws:

org.picketlink.common.exceptions.ConfigurationException

handleRequestType

public void handleRequestType(SAML2HandlerRequest request,
                     SAML2HandlerResponse response)
                       throws org.picketlink.common.exceptions.ProcessingException

Description copied from interface: SAML2Handler

Handle a SAML2 RequestAbstractType

Throws:

org.picketlink.common.exceptions.ProcessingException

handleStatusResponseType

public void handleStatusResponseType(SAML2HandlerRequest request,
                            SAML2HandlerResponse response)
                              throws org.picketlink.common.exceptions.ProcessingException

Description copied from interface: SAML2Handler

Handle a SAML2 Status Response Type

Specified by:

handleStatusResponseType in interface SAML2Handler

Overrides:

handleStatusResponseType in class BaseSAML2Handler

Throws:

org.picketlink.common.exceptions.ProcessingException

See Also:

SAML2Handler#handleStatusResponseType(SAML2HandlerRequest, SAML2HandlerResponse)}

handleIDPResponse

protected void handleIDPResponse(SAML2HandlerRequest request)