Tomcat 10.1.19 · org.apache.tomcat.websocket.Authenticator

Modifier and Type	Field and Description
private static final Pattern	pattern
private static final StringManager	sm

Access	Constructor and Description
public	Authenticator()

Method Summary

Modifier and Type	Method and Description
public abstract String	Returns: The generated authorization header value getAuthorization(String The request URI requestUri, String The server authentication header received authenticateHeader, String The user name userName, String The user password userPassword, String The realm for which the provided user name and password are valid. `null` to indicate all realms. userRealm) Generate the authorization header value that will be sent to the server.
public abstract String	Returns: the authentication scheme getSchemeName() Get the authentication method.
public Map<String, String>	Returns: a map of authentication parameter names and values parseAuthenticateHeader(String The server authenticate header received authenticateHeader) Utility method to parse the authentication header.
protected void	validatePassword(String password)
protected void	validateRealm(String userRealm, String serverRealm)
protected void	validateUsername(String userName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

pattern	back to summary
private static final Pattern pattern

sm	back to summary
private static final StringManager sm

Authenticator	back to summary
public Authenticator()

getAuthorization back to summary

getAuthorization	back to summary
public abstract String getAuthorization(String requestUri, String authenticateHeader, String userName, String userPassword, String userRealm) throws AuthenticationException Generate the authorization header value that will be sent to the server. Parameters requestUri:String The request URI authenticateHeader:String The server authentication header received userName:String The user name userPassword:String The user password userRealm:String The realm for which the provided user name and password are valid. `null` to indicate all realms. Returns:String The generated authorization header value Exceptions AuthenticationException: When an error occurs

public abstract String getAuthorization(String requestUri, String authenticateHeader, String userName, String userPassword, String userRealm) throws AuthenticationException

Generate the authorization header value that will be sent to the server.

Parameters

requestUri:String: The request URI
authenticateHeader:String: The server authentication header received
userName:String: The user name
userPassword:String: The user password
userRealm:String: The realm for which the provided user name and password are valid. null to indicate all realms.

Returns:String

The generated authorization header value

Exceptions

getSchemeName	back to summary
public abstract String getSchemeName() Get the authentication method. Returns:String the authentication scheme

getSchemeName

public abstract String getSchemeName()

Get the authentication method.

parseAuthenticateHeader	back to summary
public Map<String, String> parseAuthenticateHeader(String authenticateHeader) Utility method to parse the authentication header. Parameters authenticateHeader:String The server authenticate header received Returns:Map<String, String> a map of authentication parameter names and values

parseAuthenticateHeader

public Map<String, String> parseAuthenticateHeader(String authenticateHeader)

Utility method to parse the authentication header.

Parameters

a map of authentication parameter names and values

validatePassword	back to summary
protected void validatePassword(String password) throws AuthenticationException

validateRealm	back to summary
protected void validateRealm(String userRealm, String serverRealm) throws AuthenticationException

validateUsername	back to summary
protected void validateUsername(String userName) throws AuthenticationException