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 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 String
getAuthorization(String requestUri, String WWWAuthenticate, Map<String,Object> UserProperties)
Generate the authentication header that will be sent to the server.abstract String
getSchemeName()
Get the authentication method.Map<String,String>
parseWWWAuthenticateHeader(String WWWAuthenticate)
Utility method to parse the authentication header.
-
-
-
Method Detail
-
getAuthorization
public abstract String getAuthorization(String requestUri, String WWWAuthenticate, Map<String,Object> UserProperties) throws AuthenticationException
Generate the authentication header that will be sent to the server.- Parameters:
requestUri
- The request URIWWWAuthenticate
- The server auth challengeUserProperties
- The user information- Returns:
- The auth header
- Throws:
AuthenticationException
- When an error occurs
-
getSchemeName
public abstract String getSchemeName()
Get the authentication method.- Returns:
- the auth scheme
-
-