org.picketlink.identity.federation.bindings.tomcat.idp

Class AbstractIDPValve

java.lang.Object

ValveBase

org.picketlink.identity.federation.bindings.tomcat.idp.AbstractIDPValve

public abstract class AbstractIDPValve
extends ValveBase

Base Class for the IDPWebBrowserSSOValve

Author:

anil saldhana

Field Summary

Fields

Modifier and Type	Field and Description
protected PicketLinkAuditHelper	auditHelper
protected String	characterEncoding Character encoding to use when reading the request parameters
protected SAMLConfigurationProvider	configProvider The user can inject a fully qualified name of a SAMLConfigurationProvider
protected boolean	enableAudit
protected IDPType	idpConfiguration
protected PicketLinkType	picketLinkConfiguration
protected Timer	timer
protected int	timerInterval

Constructor Summary

Constructors

Constructor and Description
AbstractIDPValve()

Method Summary

Modifier and Type	Method and Description
Principal	authenticateSSL(Request request, Response response)
protected void	cleanUpSessionNote(Request request)
protected String	determineLoginType(boolean isSecure)
String	getCharacterEncoding() Return the character encoding to use when reading the request parameters
PicketLinkType	getConfiguration() Returns the configurations used.
protected Context	getContext()
protected abstract String	getContextPath()
protected String	getIdentityURL()
Boolean	getIgnoreIncomingSignatures() Deprecated.
TrustKeyManager	getKeyManager() Return the TrustKeyManager
Boolean	getSignOutgoingMessages() Deprecated.
protected void	handleSAML11UnsolicitedResponse(Request request, Response response)
protected void	initHandlersChain() Initialize the Handlers chain.
protected void	initIdentityServer() Initializes the IdentityServer.
protected void	initIDPConfiguration() Initializes the IDP configuration.
protected void	initKeyManager()
protected void	initSTSConfiguration() Initializes the STS configuration.
void	invoke(Request request, Response response)
protected void	processSAMLRequestMessage(Request request, Response response, RequestAbstractType requestType, boolean ignoreSignatureValidation)
protected void	processSAMLResponseMessage(Request request, Response response)
protected void	recycle(Response response)
protected void	sendErrorResponseToSP(String referrer, Response response, String relayState, IDPWebRequestUtil webRequestUtil)
void	setAttributeList(String attribList)
void	setAuditHelper(PicketLinkAuditHelper auditHelper)
void	setCharacterEncoding(String encoding) Set the character encoding to use when reading the request parameters
void	setConfigFile(String configFile)
void	setConfigProvider(SAMLConfigurationProvider configurationProvider)
void	setConfigProvider(String cp) Set the SAMLConfigurationProvider fqn
void	setIdentityParticipantStack(String fqn) Deprecated.
void	setIgnoreAttributesGeneration(Boolean ignoreAttributes) IDP should not do any attributes such as generation of roles etc
void	setIgnoreIncomingSignatures(Boolean ignoreIncomingSignature) Deprecated.
void	setPassUserPrincipalToAttributeManager(Boolean passUserPrincipalToAttributeManager) IDP should get the user principal from Request.getUserPrincipal() and send that to the attribute manager
void	setRoleGenerator(String rgName) Deprecated.
void	setSamlHandlerChainClass(String samlHandlerChainClass) Deprecated.
void	setSignOutgoingMessages(Boolean signOutgoingMessages) Deprecated.
void	setStrictPostBinding(Boolean strictPostBinding) Deprecated.
void	setTimerInterval(String value) Set the Timer Value to reload the configuration
void	setValidatingAliasToTokenIssuer(Boolean validatingAliasToTokenIssuer) Deprecated.
protected void	startPicketLink()

Methods inherited from class java.lang.Object

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

Field Detail

enableAudit

protected boolean enableAudit

auditHelper

protected PicketLinkAuditHelper auditHelper

idpConfiguration

protected IDPType idpConfiguration

picketLinkConfiguration

protected PicketLinkType picketLinkConfiguration

configProvider

protected SAMLConfigurationProvider configProvider

The user can inject a fully qualified name of a SAMLConfigurationProvider

timerInterval

protected int timerInterval

timer

protected Timer timer

characterEncoding

protected String characterEncoding

Character encoding to use when reading the request parameters

Constructor Detail

AbstractIDPValve

public AbstractIDPValve()

Method Detail

getCharacterEncoding

public String getCharacterEncoding()

Return the character encoding to use when reading the request parameters

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Set the character encoding to use when reading the request parameters

setAttributeList

public void setAttributeList(String attribList)

setTimerInterval

public void setTimerInterval(String value)

Set the Timer Value to reload the configuration

Parameters:

value - an integer value that represents timer value (in miliseconds)

setConfigProvider

public void setConfigProvider(String cp)

Set the SAMLConfigurationProvider fqn

Parameters:

cp - fqn of a SAMLConfigurationProvider

setConfigFile

public void setConfigFile(String configFile)

setConfigProvider

public void setConfigProvider(SAMLConfigurationProvider configurationProvider)

setRoleGenerator

@Deprecated
public void setRoleGenerator(String rgName)

Deprecated.

setSamlHandlerChainClass

@Deprecated
public void setSamlHandlerChainClass(String samlHandlerChainClass)

Deprecated.

setIdentityParticipantStack

@Deprecated
public void setIdentityParticipantStack(String fqn)

Deprecated.

setStrictPostBinding

@Deprecated
public void setStrictPostBinding(Boolean strictPostBinding)

Deprecated.

getIgnoreIncomingSignatures

@Deprecated
public Boolean getIgnoreIncomingSignatures()

Deprecated.

setIgnoreIncomingSignatures

@Deprecated
public void setIgnoreIncomingSignatures(Boolean ignoreIncomingSignature)

Deprecated.

setValidatingAliasToTokenIssuer

@Deprecated
public void setValidatingAliasToTokenIssuer(Boolean validatingAliasToTokenIssuer)

Deprecated.

PLFED-248 Allows to validate the token's signature against the keystore using the token's issuer.

setIgnoreAttributesGeneration

public void setIgnoreAttributesGeneration(Boolean ignoreAttributes)

IDP should not do any attributes such as generation of roles etc

Parameters:

ignoreAttributes -

getSignOutgoingMessages

@Deprecated
public Boolean getSignOutgoingMessages()

Deprecated.

setSignOutgoingMessages

@Deprecated
public void setSignOutgoingMessages(Boolean signOutgoingMessages)

Deprecated.

setPassUserPrincipalToAttributeManager

public void setPassUserPrincipalToAttributeManager(Boolean passUserPrincipalToAttributeManager)

IDP should get the user principal from Request.getUserPrincipal() and send that to the attribute manager

Parameters:

passUserPrincipalToAttributeManager -

getConfiguration

public PicketLinkType getConfiguration()

Returns the configurations used.

Returns:

getKeyManager

public TrustKeyManager getKeyManager()

Return the TrustKeyManager

Returns:

invoke

public void invoke(Request request,
                   Response response)
            throws IOException,
                   ServletException

Throws:

IOException

ServletException

authenticateSSL

public Principal authenticateSSL(Request request,
                                 Response response)
                          throws IOException

Throws:

IOException

handleSAML11UnsolicitedResponse

protected void handleSAML11UnsolicitedResponse(Request request,
                                               Response response)
                                        throws ServletException,
                                               IOException

Throws:

ServletException

IOException

processSAMLRequestMessage

protected void processSAMLRequestMessage(Request request,
                                         Response response,
                                         RequestAbstractType requestType,
                                         boolean ignoreSignatureValidation)
                                  throws IOException

Throws:

IOException

processSAMLResponseMessage

protected void processSAMLResponseMessage(Request request,
                                          Response response)
                                   throws ServletException,
                                          IOException

Throws:

ServletException

IOException

cleanUpSessionNote

protected void cleanUpSessionNote(Request request)

sendErrorResponseToSP

protected void sendErrorResponseToSP(String referrer,
                                     Response response,
                                     String relayState,
                                     IDPWebRequestUtil webRequestUtil)
                              throws ServletException,
                                     IOException,
                                     ConfigurationException

Throws:

ServletException

IOException

ConfigurationException

initIdentityServer

protected void initIdentityServer()

Initializes the IdentityServer.

initHandlersChain

protected void initHandlersChain()
                          throws LifecycleException

Initialize the Handlers chain.

Throws:

LifecycleException

initKeyManager

protected void initKeyManager()
                       throws LifecycleException

Throws:

LifecycleException

initIDPConfiguration

protected void initIDPConfiguration()

Initializes the IDP configuration.

initSTSConfiguration

protected void initSTSConfiguration()

Initializes the STS configuration.

getIdentityURL

protected String getIdentityURL()

getContext

protected Context getContext()

getContextPath

protected abstract String getContextPath()

recycle

protected void recycle(Response response)

determineLoginType

protected String determineLoginType(boolean isSecure)

startPicketLink

protected void startPicketLink()
                        throws LifecycleException

Throws:

LifecycleException

setAuditHelper

public void setAuditHelper(PicketLinkAuditHelper auditHelper)