org.apache.catalina

public Interface Authenticator

Known Direct Implementers: org.apache.catalina.authenticator.AuthenticatorBase
Imports: java.io.IOException, jakarta.servlet.ServletException, jakarta.servlet.http.HttpServletResponse, org.apache.catalina.connector.Request

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

Author: Craig R. McClanahan

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if any specified constraints have been satisfied, or `false` if one more constraints were not satisfied (in which case an authentication challenge will have been written to the response). authenticate(Request Request we are processing request, HttpServletResponse Response we are populating response) Authenticate the user making this request, based on the login configuration of the `Context` with which this Authenticator is associated.
public void	login(String userName, String password, Request request)
public void	logout(Request request)

Method Detail

authenticate back to summary

authenticate	back to summary
public boolean authenticate(Request request, HttpServletResponse response) throws IOException Authenticate the user making this request, based on the login configuration of the `Context` with which this Authenticator is associated. Parameters request:Request Request we are processing response:HttpServletResponse Response we are populating Returns:boolean `true` if any specified constraints have been satisfied, or `false` if one more constraints were not satisfied (in which case an authentication challenge will have been written to the response). Exceptions IOException: if an input/output error occurs

public boolean authenticate(Request request, HttpServletResponse response) throws IOException

Authenticate the user making this request, based on the login configuration of the Context with which this Authenticator is associated.

Parameters

request:Request: Request we are processing
response:HttpServletResponse: Response we are populating

Returns:boolean

true if any specified constraints have been satisfied, or false if one more constraints were not satisfied (in which case an authentication challenge will have been written to the response).

Exceptions

IOException:: if an input/output error occurs

login	back to summary
public void login(String userName, String password, Request request) throws ServletException

logout	back to summary
public void logout(Request request)