org.apache.catalina.authenticator

Class BasicAuthenticator

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

public class BasicAuthenticator
extends AuthenticatorBase

An Authenticator and Valve implementation of HTTP BASIC Authentication, as outlined in RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication."

Version:
$Revision: 1.6 $ $Date: 2004/05/16 14:42:36 $

Author:
Craig R. McClanahan

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 String
parsePassword(String authorization)
Parse the password from the specified authorization credentials.
protected String
parseUsername(String authorization)
Parse the username from the specified authorization credentials.

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


parsePassword

protected String parsePassword(String authorization)
Parse the password from the specified authorization credentials. If none can be found, return null.

Parameters:
authorization - Authorization credentials from this request


parseUsername

protected String parseUsername(String authorization)
Parse the username from the specified authorization credentials. If none can be found, return null.

Parameters:
authorization - Authorization credentials from this request


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