Package org.apache.tomcat.websocket
Class Authenticator
java.lang.Object
org.apache.tomcat.websocket.Authenticator
- Direct Known Subclasses:
- BasicAuthenticator,- DigestAuthenticator
Base class for the authentication methods used by the WebSocket client.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionabstract StringgetAuthorization(String requestUri, String authenticateHeader, String userName, String userPassword, String userRealm) Generate the authorization header value that will be sent to the server.Deprecated.abstract StringGet the authentication method.parseAuthenticateHeader(String authenticateHeader) Utility method to parse the authentication header.parseWWWAuthenticateHeader(String authenticateHeader) Deprecated.protected voidvalidatePassword(String password) protected voidvalidateRealm(String userRealm, String serverRealm) protected voidvalidateUsername(String userName) 
- 
Constructor Details- 
Authenticatorpublic Authenticator()
 
- 
- 
Method Details- 
getAuthorization@Deprecated public String getAuthorization(String requestUri, String authenticateHeader, Map<String, Object> userProperties) throws AuthenticationExceptionDeprecated.UsegetAuthorization(String, String, String, String, String). Will be removed in Tomcat 10.1.xGenerate the authorization header value that will be sent to the server.- Parameters:
- requestUri- The request URI
- authenticateHeader- The server authentication header received
- userProperties- The user information
- Returns:
- The generated authorization header value
- Throws:
- AuthenticationException- When an error occurs
 
- 
getAuthorizationpublic 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- The request URI
- authenticateHeader- The server authentication header received
- userName- The user name
- userPassword- The user password
- userRealm- The realm for which the provided user name and password are valid.- nullto indicate all realms.
- Returns:
- The generated authorization header value
- Throws:
- AuthenticationException- When an error occurs
 
- 
getSchemeNameGet the authentication method.- Returns:
- the authentication scheme
 
- 
parseWWWAuthenticateHeaderDeprecated.UseparseAuthenticateHeader(String). Will be removed in Tomcat 10.1.x onwardsUtility method to parse the authentication header.- Parameters:
- authenticateHeader- The server authenticate header received
- Returns:
- a map of authentication parameter names and values
 
- 
parseAuthenticateHeaderUtility method to parse the authentication header.- Parameters:
- authenticateHeader- The server authenticate header received
- Returns:
- a map of authentication parameter names and values
 
- 
validateUsername- Throws:
- AuthenticationException
 
- 
validatePassword- Throws:
- AuthenticationException
 
- 
validateRealm- Throws:
- AuthenticationException
 
 
- 
getAuthorization(String, String, String, String, String).