org.picketlink.social.openid

Class OpenIDConsumerAuthenticator

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.FormAuthenticator

org.picketlink.social.openid.OpenIDConsumerAuthenticator

All Implemented Interfaces:

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

public class OpenIDConsumerAuthenticator
extends org.apache.catalina.authenticator.FormAuthenticator

Tomcat Authenticator that provides OpenID based authentication

Since:

Sep 17, 2011

Author:

Anil Saldhana

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<Principal>	cachedPrincipal
static ThreadLocal<List<String>>	cachedRoles
static String	EMPTY_PASSWORD
protected static Logger	log
protected OpenIDProcessor	processor
protected List<String>	roles
protected boolean	saveRestoreRequest
protected boolean	trace

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
OpenIDConsumerAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(HttpServletRequest request, HttpServletResponse response, org.apache.catalina.deploy.LoginConfig loginConfig)
boolean	authenticate(org.apache.catalina.connector.Request request, HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config) Authenticate the request
boolean	authenticate(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, org.apache.catalina.deploy.LoginConfig loginConfig)
protected void	registerWithAuthenticatorBase(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, Principal principal, String userName)
void	setOptionalAttributes(String optionalAttributes)
void	setRequiredAttributes(String requiredAttributes)
void	setReturnURL(String returnURL)
void	setRoleString(String roleStr) A comma separated string that represents the roles the web app needs to pass authorization
void	setSaveRestoreRequest(boolean saveRestoreRequest)

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

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 Logger log

trace

protected boolean trace

cachedPrincipal

public static ThreadLocal<Principal> cachedPrincipal

cachedRoles

public static ThreadLocal<List<String>> cachedRoles

EMPTY_PASSWORD

public static String EMPTY_PASSWORD

roles

protected List<String> roles

saveRestoreRequest

protected boolean saveRestoreRequest

processor

protected OpenIDProcessor processor

Constructor Detail

OpenIDConsumerAuthenticator

public OpenIDConsumerAuthenticator()

Method Detail

setReturnURL

public void setReturnURL(String returnURL)

setRequiredAttributes

public void setRequiredAttributes(String requiredAttributes)

setOptionalAttributes

public void setOptionalAttributes(String optionalAttributes)

setSaveRestoreRequest

public void setSaveRestoreRequest(boolean saveRestoreRequest)

setRoleString

public void setRoleString(String roleStr)

A comma separated string that represents the roles the web app needs to pass authorization

Parameters:

roleStr -

authenticate

public boolean authenticate(HttpServletRequest request,
                   HttpServletResponse response,
                   org.apache.catalina.deploy.LoginConfig loginConfig)
                     throws IOException

Throws:

IOException

authenticate

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

Authenticate the request

Overrides:

authenticate in class org.apache.catalina.authenticator.FormAuthenticator

Parameters:

request -

response -

config -

Returns:

Throws:

IOException

{@link - RuntimeException} when the response is not of type catalina response object

authenticate

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

Throws:

IOException

registerWithAuthenticatorBase

protected void registerWithAuthenticatorBase(org.apache.catalina.connector.Request request,
                                 org.apache.catalina.connector.Response response,
                                 Principal principal,
                                 String userName)