org.picketlink.identity.federation.bindings.tomcat.sp

Class AbstractAccountChooserValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.picketlink.identity.federation.bindings.tomcat.sp.AbstractAccountChooserValve

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Contained, org.apache.catalina.Lifecycle, org.apache.catalina.Valve

Direct Known Subclasses:

AccountChooserValve

public abstract class AbstractAccountChooserValve
extends org.apache.catalina.valves.ValveBase
implements org.apache.catalina.Lifecycle

PLINK-344: Account Chooser At the Service Provider to enable redirection to the appropriate IDP

Since:

January 21, 2014

Author:

Anil Saldhana

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractAccountChooserValve.AccountIDPMapProvider Interface for obtaining the Identity Provider Mapping

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCOUNT_CHOOSER_COOKIE_NAME
static String	ACCOUNT_PARAMETER
protected String	accountChooserPage
protected AbstractAccountChooserValve.AccountIDPMapProvider	accountIDPMapProvider
static String	AUTHENTICATING
protected int	cookieExpiry Sets the account chooser cookie expiry.
protected String	domainName Domain Name to be used in the cookie that is sent out
protected ConcurrentHashMap<String,String>	idpMap
protected org.apache.catalina.util.LifecycleSupport	lifecycle The lifecycle event support for this component.
protected static PicketLinkLogger	logger
static String	STATE

Fields inherited from class org.apache.catalina.valves.ValveBase

container, controller, domain, info, mserver, next, oname

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_LOAD_ON_STARTUP_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, AFTER_UNLOAD_EVENT, BEFORE_LOAD_ON_STARTUP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, BEFORE_UNLOAD_EVENT, DESTROY_EVENT, INIT_EVENT, LOAD_ON_STARTUP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
AbstractAccountChooserValve()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLifecycleListener(org.apache.catalina.LifecycleListener listener)
protected String	cookieValue(org.apache.catalina.connector.Request request)
org.apache.catalina.LifecycleListener[]	findLifecycleListeners()
void	invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
protected void	proceedToAuthentication(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, String cookieValue) Proceed to the Service Provider Authentication Mechanism
protected void	redirectToChosenPage(String page, org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response) Redirect user to a page
void	removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
protected abstract boolean	restoreRequest(org.apache.catalina.connector.Request request, org.apache.catalina.Session session) Restore the original request from information stored in our session.
protected abstract void	saveRequest(org.apache.catalina.connector.Request request, org.apache.catalina.Session session) Save the original request information into our session.
void	setAccountChooserPage(String pageName) Set the name of the html or jsp page that has the accounts for the user to choose.
void	setAccountIDPMapProvider(String idpMapProviderName) Set the fully qualified name of the implementation of AbstractAccountChooserValve.AccountIDPMapProvider Default: PropertiesAccountMapProvider
void	setCookieExpiry(String value) Set the cookie expiry in seconds.
void	setDomainName(String domainName) Set the domain name for the cookie to be sent to the browser There is no default.
void	start()
void	stop()

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, createObjectName, event, getContainer, getContainerName, getController, getDomain, getInfo, getNext, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setNext, setObjectName, toString

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final PicketLinkLogger logger

ACCOUNT_CHOOSER_COOKIE_NAME

public static final String ACCOUNT_CHOOSER_COOKIE_NAME

See Also:

Constant Field Values

ACCOUNT_PARAMETER

public static final String ACCOUNT_PARAMETER

See Also:

Constant Field Values

AUTHENTICATING

public static final String AUTHENTICATING

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

domainName

protected String domainName

Domain Name to be used in the cookie that is sent out

accountChooserPage

protected String accountChooserPage

idpMap

protected ConcurrentHashMap<String,String> idpMap

accountIDPMapProvider

protected AbstractAccountChooserValve.AccountIDPMapProvider accountIDPMapProvider

cookieExpiry

protected int cookieExpiry

Sets the account chooser cookie expiry. By default, we choose -1 which means cookie exists for the remainder of the browser session.

lifecycle

protected org.apache.catalina.util.LifecycleSupport lifecycle

The lifecycle event support for this component.

Constructor Detail

AbstractAccountChooserValve

public AbstractAccountChooserValve()

Method Detail

start

public void start()
           throws org.apache.catalina.LifecycleException

Specified by:

start in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Specified by:

stop in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

removeLifecycleListener

public void removeLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

removeLifecycleListener in interface org.apache.catalina.Lifecycle

findLifecycleListeners

public org.apache.catalina.LifecycleListener[] findLifecycleListeners()

Specified by:

findLifecycleListeners in interface org.apache.catalina.Lifecycle

addLifecycleListener

public void addLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

addLifecycleListener in interface org.apache.catalina.Lifecycle

setDomainName

public void setDomainName(String domainName)

Set the domain name for the cookie to be sent to the browser There is no default. Setting the domain name for the cookie is optional.

Parameters:

domainName -

setCookieExpiry

public void setCookieExpiry(String value)

Set the cookie expiry in seconds. Default value is -1

Parameters:

value -

setAccountIDPMapProvider

public void setAccountIDPMapProvider(String idpMapProviderName)

Set the fully qualified name of the implementation of AbstractAccountChooserValve.AccountIDPMapProvider Default: PropertiesAccountMapProvider

Parameters:

idpMapProviderName -

setAccountChooserPage

public void setAccountChooserPage(String pageName)

Set the name of the html or jsp page that has the accounts for the user to choose. Default: "/accountChooser.html" is used

Parameters:

pageName -

invoke

public void invoke(org.apache.catalina.connector.Request request,
          org.apache.catalina.connector.Response response)
            throws IOException,
                   ServletException

Specified by:

invoke in interface org.apache.catalina.Valve

Specified by:

invoke in class org.apache.catalina.valves.ValveBase

Throws:

IOException

ServletException

proceedToAuthentication

protected void proceedToAuthentication(org.apache.catalina.connector.Request request,
                           org.apache.catalina.connector.Response response,
                           String cookieValue)
                                throws IOException,
                                       ServletException

Proceed to the Service Provider Authentication Mechanism

Parameters:

request -

response -

cookieValue -

Throws:

IOException

ServletException

redirectToChosenPage

protected void redirectToChosenPage(String page,
                        org.apache.catalina.connector.Request request,
                        org.apache.catalina.connector.Response response)
                             throws ServletException,
                                    IOException

Redirect user to a page

Parameters:

page -

request -

response -

Throws:

ServletException

IOException

cookieValue

protected String cookieValue(org.apache.catalina.connector.Request request)

saveRequest

protected abstract void saveRequest(org.apache.catalina.connector.Request request,
               org.apache.catalina.Session session)
                             throws IOException

Save the original request information into our session.

Parameters:

request - The request to be saved

session - The session to contain the saved information

Throws:

IOException

restoreRequest

protected abstract boolean restoreRequest(org.apache.catalina.connector.Request request,
                     org.apache.catalina.Session session)
                                   throws IOException

Restore the original request from information stored in our session. If the original request is no longer present (because the session timed out), return false; otherwise, return true.

Parameters:

request - The request to be restored

session - The session containing the saved information

Throws:

IOException