org.apache.catalina
Interface Authenticator

All Known Implementing Classes:

AuthenticatorBase, BasicAuthenticator, DigestAuthenticator, FormAuthenticator, NonLoginAuthenticator, SSLAuthenticator

public interface Authenticator

An Authenticator is a component (usually a Valve or Container) that provides some sort of authentication service.

Version:

$Id: Authenticator.java 1005834 2010-10-08 14:02:05Z markt $

Author:

Craig R. McClanahan

Method Summary

boolean	authenticate(Request request, HttpServletResponse response, LoginConfig config) Authenticate the user making this request, based on the specified login configuration.
void	login(String userName, String password, Request request)
void	logout(Request request)

Method Detail

authenticate

boolean authenticate(Request request,
                     HttpServletResponse 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.

Parameters:

request - Request we are processing

response - Response we are populating

config - Login configuration describing how authentication should be performed

Throws:

IOException - if an input/output error occurs

login

void login(String userName,
           String password,
           Request request)
           throws ServletException

Throws:

ServletException

logout

void logout(Request request)
            throws ServletException

Throws:

ServletException