org.apache.catalina.authenticator
Class BasicAuthenticator

java.lang.Object
  org.apache.catalina.valves.ValveBase
      org.apache.catalina.authenticator.AuthenticatorBase
          org.apache.catalina.authenticator.BasicAuthenticator

All Implemented Interfaces:

Authenticator, Contained, Lifecycle, javax.management.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.3 $ $Date: 2003/11/24 16:46:56 $

Author:

Craig R. McClanahan

Field Summary

protected static Base64	base64Helper The Base64 helper object for this class.
protected static java.lang.String	info Descriptive information about this implementation.

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

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

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

container, controller, domain, mserver, oname

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

BasicAuthenticator()

Method Summary

boolean	authenticate(HttpRequest request, HttpResponse response, LoginConfig config) Authenticate the user making this request, based on the specified login configuration.
java.lang.String	getInfo() Return descriptive information about this Valve implementation.
protected java.lang.String	parsePassword(java.lang.String authorization) Parse the password from the specified authorization credentials.
protected java.lang.String	parseUsername(java.lang.String authorization) Parse the username from the specified authorization credentials.

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

addLifecycleListener, associate, findLifecycleListeners, generateSessionId, getAlgorithm, getCache, getContainer, getDebug, getDigest, getDisableProxyCaching, getEntropy, 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, getContainerName, getController, getDomain, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setController, setObjectName

Methods inherited from class java.lang.Object

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

Field Detail

base64Helper

protected static final Base64 base64Helper

The Base64 helper object for this class.

info

protected static final java.lang.String info

Descriptive information about this implementation.

See Also:

Constant Field Values

Constructor Detail

BasicAuthenticator

public BasicAuthenticator()

Method Detail

getInfo

public java.lang.String getInfo()

Return descriptive information about this Valve implementation.

Specified by:

getInfo in interface Valve

Overrides:

getInfo in class AuthenticatorBase

authenticate

public boolean authenticate(HttpRequest request,
                            HttpResponse response,
                            LoginConfig config)
                     throws java.io.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.

Specified by:

authenticate in class AuthenticatorBase

Parameters:

request - Request we are processing

response - Response we are creating

config - Login configuration describing how authentication should be performed

Throws:

java.io.IOException - if an input/output error occurs

parseUsername

protected java.lang.String parseUsername(java.lang.String authorization)

Parse the username from the specified authorization credentials. If none can be found, return null.

Parameters:

authorization - Authorization credentials from this request

parsePassword

protected java.lang.String parsePassword(java.lang.String authorization)

Parse the password from the specified authorization credentials. If none can be found, return null.

Parameters:

authorization - Authorization credentials from this request