Package org.apache.tomcat.websocket
Class Authenticator
- java.lang.Object
- 
- org.apache.tomcat.websocket.Authenticator
 
- 
- Direct Known Subclasses:
- BasicAuthenticator,- DigestAuthenticator
 
 public abstract class Authenticator extends java.lang.ObjectBase class for the authentication methods used by the WebSocket client.
- 
- 
Constructor SummaryConstructors Constructor Description Authenticator()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract java.lang.StringgetAuthorization(java.lang.String requestUri, java.lang.String authenticateHeader, java.lang.String userName, java.lang.String userPassword, java.lang.String userRealm)Generate the authorization header value that will be sent to the server.java.lang.StringgetAuthorization(java.lang.String requestUri, java.lang.String authenticateHeader, java.util.Map<java.lang.String,java.lang.Object> userProperties)Deprecated.abstract java.lang.StringgetSchemeName()Get the authentication method.java.util.Map<java.lang.String,java.lang.String>parseAuthenticateHeader(java.lang.String authenticateHeader)Utility method to parse the authentication header.java.util.Map<java.lang.String,java.lang.String>parseWWWAuthenticateHeader(java.lang.String authenticateHeader)Deprecated.protected voidvalidatePassword(java.lang.String password)protected voidvalidateRealm(java.lang.String userRealm, java.lang.String serverRealm)protected voidvalidateUsername(java.lang.String userName)
 
- 
- 
- 
Method Detail- 
getAuthorization@Deprecated public java.lang.String getAuthorization(java.lang.String requestUri, java.lang.String authenticateHeader, java.util.Map<java.lang.String,java.lang.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 java.lang.String getAuthorization(java.lang.String requestUri, java.lang.String authenticateHeader, java.lang.String userName, java.lang.String userPassword, java.lang.String userRealm) throws AuthenticationExceptionGenerate 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
 
 - 
getSchemeNamepublic abstract java.lang.String getSchemeName() Get the authentication method.- Returns:
- the authentication scheme
 
 - 
parseWWWAuthenticateHeader@Deprecated public java.util.Map<java.lang.String,java.lang.String> parseWWWAuthenticateHeader(java.lang.String authenticateHeader) Deprecated.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
 
 - 
parseAuthenticateHeaderpublic java.util.Map<java.lang.String,java.lang.String> parseAuthenticateHeader(java.lang.String authenticateHeader) Utility method to parse the authentication header.- Parameters:
- authenticateHeader- The server authenticate header received
- Returns:
- a map of authentication parameter names and values
 
 - 
validateUsernameprotected void validateUsername(java.lang.String userName) throws AuthenticationException- Throws:
- AuthenticationException
 
 - 
validatePasswordprotected void validatePassword(java.lang.String password) throws AuthenticationException- Throws:
- AuthenticationException
 
 - 
validateRealmprotected void validateRealm(java.lang.String userRealm, java.lang.String serverRealm) throws AuthenticationException- Throws:
- AuthenticationException
 
 
- 
 
-