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.Object
Base class for the authentication methods used by the WebSocket client.
-
-
Constructor Summary
Constructors Constructor Description Authenticator()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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)
Generate the authorization header value that will be sent to the server.abstract java.lang.String
getSchemeName()
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.protected void
validatePassword(java.lang.String password)
protected void
validateRealm(java.lang.String userRealm, java.lang.String serverRealm)
protected void
validateUsername(java.lang.String userName)
-
-
-
Method Detail
-
getAuthorization
public 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 AuthenticationException
Generate the authorization header value that will be sent to the server.- Parameters:
requestUri
- The request URIauthenticateHeader
- The server authentication header receiveduserName
- The usernameuserPassword
- The user passworduserRealm
- The realm for which the provided username and password are valid.null
to indicate all realms.- Returns:
- The generated authorization header value
- Throws:
AuthenticationException
- When an error occurs
-
getSchemeName
public abstract java.lang.String getSchemeName()
Get the authentication method.- Returns:
- the authentication scheme
-
parseAuthenticateHeader
public 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
-
validateUsername
protected void validateUsername(java.lang.String userName) throws AuthenticationException
- Throws:
AuthenticationException
-
validatePassword
protected void validatePassword(java.lang.String password) throws AuthenticationException
- Throws:
AuthenticationException
-
validateRealm
protected void validateRealm(java.lang.String userRealm, java.lang.String serverRealm) throws AuthenticationException
- Throws:
AuthenticationException
-
-