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 939305 2010-04-29 13:43:39Z kkolinko $

Author:

Craig R. McClanahan

Method Summary

boolean	authenticate(Request request, javax.servlet.http.HttpServletResponse response, LoginConfig config) Authenticate the user making this request, based on the specified login configuration.
void	register(Request request, javax.servlet.http.HttpServletResponse response, Principal principal, String authType, String username, String password) Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one.

Method Detail

authenticate

boolean authenticate(Request request,
                     javax.servlet.http.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

register

void register(Request request,
              javax.servlet.http.HttpServletResponse response,
              Principal principal,
              String authType,
              String username,
              String password)

Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one. Set the appropriate cookie to be returned. Passing in a null principal will de-register any SSO sessions.

Parameters:

request - The servlet request we are processing

response - The servlet response we are populating

principal - The authenticated Principal to be registered

authType - The authentication type to be registered

username - Username used to authenticate (if any)

password - Password used to authenticate (if any)