org.apache.catalina.authenticator

Class FormAuthenticator

Implemented Interfaces:
Authenticator, Contained, Lifecycle, MBeanRegistration, Valve

public class FormAuthenticator
extends AuthenticatorBase

An Authenticator and Valve implementation of FORM BASED Authentication, as described in the Servlet API Specification, Version 2.2.

Version:
$Revision: 1.9.2.1 $ $Date: 2004/09/10 07:28:57 $

Authors:
Craig R. McClanahan
Remy Maucherat

Field Summary

protected static String
info
Descriptive information about this implementation.

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

DEFAULT_ALGORITHM, SESSION_ID_BYTES, algorithm, cache, context, debug, digest, disableProxyCaching, entropy, info, lifecycle, random, randomClass, sm, sso, started

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

container, controller, debug, domain, info, mserver, oname, sm

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Method Summary

boolean
authenticate(HttpRequest request, HttpResponse response, LoginConfig config)
Authenticate the user making this request, based on the specified login configuration.
String
getInfo()
Return descriptive information about this Valve implementation.
protected boolean
matchRequest(HttpRequest request)
Does this request match the saved one (so that it must be the redirect we signalled after successful authentication?
protected boolean
restoreRequest(HttpRequest request, Session session)
Restore the original request from information stored in our session.

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

addLifecycleListener, associate, authenticate, findLifecycleListeners, generateSessionId, getAlgorithm, getCache, getContainer, getDebug, getDigest, getDisableProxyCaching, getEntropy, getInfo, getRandom, getRandomClass, getSession, getSession, invoke, log, log, reauthenticateFromSSO, register, removeLifecycleListener, setAlgorithm, setCache, setContainer, setDebug, setDisableProxyCaching, setEntropy, setRandomClass, start, stop

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

createObjectName, getContainer, getContainerName, getController, getDebug, getDomain, getInfo, getObjectName, getParentName, invoke, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setDebug, setObjectName

Field Details

info

protected static final String info
Descriptive information about this implementation.

Method Details

authenticate

public boolean authenticate(HttpRequest request,
                            HttpResponse response,
                            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 interface AuthenticatorBase

Parameters:
request - Request we are processing
response - Response we are creating
config - Login configuration describing how authentication should be performed


getInfo

public String getInfo()
Return descriptive information about this Valve implementation.
Specified by:
getInfo in interface Valve
Overrides:
getInfo in interface AuthenticatorBase


matchRequest

protected boolean matchRequest(HttpRequest request)
Does this request match the saved one (so that it must be the redirect we signalled after successful authentication?

Parameters:
request - The request to be verified


restoreRequest

protected boolean restoreRequest(HttpRequest request,
                                 Session session)
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


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.