org.jboss.as.web.security

Class ExtendedFormAuthenticator

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.FormAuthenticator

org.jboss.as.web.security.ExtendedFormAuthenticator

All Implemented Interfaces:

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

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

An extension of the form authenticator that associates the j_username with the session under the attribute name j_username for use by form login/error pages. If the includePassword attribute is true, the j_password value is also included in the session under the attribute name j_password. In addition, it maps any authentication exception found in the SecurityAssociation to the session attribute name j_exception.

Author:

Scott.Stark@jboss.org, Marcus Moyses

Field Summary

Fields

Modifier and Type	Field and Description
static String	DID_POPULATE
static String	LOGIN_EXCEPTION

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

characterEncoding, info, landingPage

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

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

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

container, controller, domain, mserver, next, oname

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
ExtendedFormAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config) Authenticate the user making this request, based on the specified login configuration.
protected void	forwardToErrorPage(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config) Dispatch to the form error-page
protected void	forwardToLoginPage(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config) Dispatch to the form login-page
boolean	isIncludePassword()
protected void	populateSession(org.apache.catalina.connector.Request request) Populates the session the request belongs to with authentication data as described above.
void	setIncludePassword(boolean includePassword)

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

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, login, logout, reauthenticateFromSSO, register, removeLifecycleListener, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, 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

LOGIN_EXCEPTION

public static final String LOGIN_EXCEPTION

See Also:

Constant Field Values

DID_POPULATE

public static final String DID_POPULATE

See Also:

Constant Field Values

Constructor Detail

ExtendedFormAuthenticator

public ExtendedFormAuthenticator()

Method Detail

isIncludePassword

public boolean isIncludePassword()

setIncludePassword

public void setIncludePassword(boolean includePassword)

authenticate

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

Authenticate the user making this request, based on the specified login configuration. Return true if any specified constraint has been satisfied, or false if we have created a response challenge already.

Overrides:

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

Parameters:

request - Request we are processing

response - Response we are creating

config - Login configuration describing how authentication should be performed

Throws:

IOException - if an input/output error occurs

forwardToErrorPage

protected void forwardToErrorPage(org.apache.catalina.connector.Request request,
                      javax.servlet.http.HttpServletResponse response,
                      org.apache.catalina.deploy.LoginConfig config)
                           throws IOException

Dispatch to the form error-page

Overrides:

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

Parameters:

request - Request we are processing

response - Response we are creating

config - Login configuration describing how authentication should be performed

Throws:

IOException

forwardToLoginPage

protected void forwardToLoginPage(org.apache.catalina.connector.Request request,
                      javax.servlet.http.HttpServletResponse response,
                      org.apache.catalina.deploy.LoginConfig config)
                           throws IOException

Dispatch to the form login-page

Overrides:

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

Parameters:

request - Request we are processing

response - Response we are creating

config - Login configuration describing how authentication should be performed

Throws:

IOException

populateSession

protected void populateSession(org.apache.catalina.connector.Request request)

Populates the session the request belongs to with authentication data as described above. If the request does not have an associated session does nothing.

Parameters:

request - Request we are processing