org.picketlink.identity.federation.bindings.tomcat

Class AbstractGenericHeaderAuthenticator

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.FormAuthenticator

org.picketlink.identity.federation.bindings.tomcat.AbstractGenericHeaderAuthenticator

All Implemented Interfaces:

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

Direct Known Subclasses:

GenericHeaderAuthenticator

public abstract class AbstractGenericHeaderAuthenticator
extends org.apache.catalina.authenticator.FormAuthenticator

JBAS-2283: Provide custom header based authentication support Header Authenticator that deals with userid from the request header Requires two attributes configured on the Tomcat Service - one for the http header denoting the authenticated identity and the other is the SESSION cookie

Since:

Sep 11, 2006

Version:

$Revision$

Author:

Anil Saldhana, Stefan Guilhen

Field Summary

Fields

Modifier and Type	Field and Description
protected static PicketLinkLogger	log

Fields inherited from class org.apache.catalina.authenticator.FormAuthenticator

characterEncoding, info, landingPage

Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase

alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, lifecycle, REALM_NAME, securePagesWithPragma, SESSION_ID_BYTES, sso, started, unregisterSsoOnLogout

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

container, controller, domain, 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
AbstractGenericHeaderAuthenticator() Creates an instance of AbstractGenericHeaderAuthenticator.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getCookieValue(Cookie[] cookies, int numCookies, String token) Get the value of a cookie if the name matches the token
String	getHttpHeaderForSSOAuth() Obtain the value of the httpHeaderForSSOAuth attribute.
protected String	getSessionCookie(org.apache.catalina.connector.Request request) Obtain the session cookie from the request
String	getSessionCookieForSSOAuth() Obtain the value of the sessionCookieForSSOAuth attribute.
protected String	getUserId(org.apache.catalina.connector.Request request) Get the username from the request header
boolean	performAuthentication(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, org.apache.catalina.deploy.LoginConfig config)
void	setHttpHeaderForSSOAuth(String httpHeaderForSSOAuth) Set the value of the httpHeaderForSSOAuth attribute.
void	setSessionCookieForSSOAuth(String sessionCookieForSSOAuth) Set the value of the sessionCookieForSSOAuth attribute.

Methods inherited from class org.apache.catalina.authenticator.FormAuthenticator

authenticate, forwardToErrorPage, forwardToLoginPage, getCharacterEncoding, getInfo, getLandingPage, matchRequest, restoreRequest, savedRequestURL, saveRequest, setCharacterEncoding, setLandingPage

Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase

addLifecycleListener, associate, authenticate, findLifecycleListeners, generateSessionId, getCache, getContainer, getDisableProxyCaching, getSecurePagesWithPragma, invoke, isChangeSessionIdOnAuthentication, isUnregisterSsoOnLogout, login, logout, reauthenticateFromSSO, register, removeLifecycleListener, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setUnregisterSsoOnLogout, start, stop, unregister

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

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

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final PicketLinkLogger log

Constructor Detail

AbstractGenericHeaderAuthenticator

public AbstractGenericHeaderAuthenticator()

Creates an instance of AbstractGenericHeaderAuthenticator.

Method Detail

getHttpHeaderForSSOAuth

public String getHttpHeaderForSSOAuth()

Obtain the value of the httpHeaderForSSOAuth attribute. This attribute is used to indicate the request header ids that have to be checked in order to retrieve the SSO identity set by a third party security system.

Returns:

a String containing the value of the httpHeaderForSSOAuth attribute.

setHttpHeaderForSSOAuth

public void setHttpHeaderForSSOAuth(String httpHeaderForSSOAuth)

Set the value of the httpHeaderForSSOAuth attribute. This attribute is used to indicate the request header ids that have to be checked in order to retrieve the SSO identity set by a third party security system.

Parameters:

httpHeaderForSSOAuth - a String containing the value of the httpHeaderForSSOAuth attribute.

getSessionCookieForSSOAuth

public String getSessionCookieForSSOAuth()

Obtain the value of the sessionCookieForSSOAuth attribute. This attribute is used to indicate the names of the SSO cookies that may be present in the request object.

Returns:

a String containing the names (separated by a ',') of the SSO cookies that may have been set by a third party security system in the request.

setSessionCookieForSSOAuth

public void setSessionCookieForSSOAuth(String sessionCookieForSSOAuth)

Set the value of the sessionCookieForSSOAuth attribute. This attribute is used to indicate the names of the SSO cookies that may be present in the request object.

Parameters:

sessionCookieForSSOAuth - a String containing the names (separated by a ',') of the SSO cookies that may have been set by a third party security system in the request.

performAuthentication

public boolean performAuthentication(org.apache.catalina.connector.Request request,
                            org.apache.catalina.connector.Response response,
                            org.apache.catalina.deploy.LoginConfig config)
                              throws IOException

Throws:

IOException

getUserId

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

Get the username from the request header

Parameters:

request -

Returns:

getSessionCookie

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

Obtain the session cookie from the request

Parameters:

request -

Returns:

getCookieValue

protected String getCookieValue(Cookie[] cookies,
                    int numCookies,
                    String token)

Get the value of a cookie if the name matches the token

Parameters:

cookies - array of cookies

numCookies - number of cookies in the array

token - Key

Returns:

value of cookie