Package org.apache.tomcat.websocket
Class BasicAuthenticator
- java.lang.Object
- 
- org.apache.tomcat.websocket.Authenticator
- 
- org.apache.tomcat.websocket.BasicAuthenticator
 
 
- 
 public class BasicAuthenticator extends Authenticator Authenticator supporting the BASIC authentication method.
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.Stringcharsetparamstatic java.lang.StringschemeName
 - 
Constructor SummaryConstructors Constructor Description BasicAuthenticator()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.StringgetSchemeName()Get the authentication method.- 
Methods inherited from class org.apache.tomcat.websocket.AuthenticatorgetAuthorization, parseAuthenticateHeader, parseWWWAuthenticateHeader, validatePassword, validateRealm, validateUsername
 
- 
 
- 
- 
- 
Field Detail- 
schemeNamepublic static final java.lang.String schemeName - See Also:
- Constant Field Values
 
 - 
charsetparampublic static final java.lang.String charsetparam - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getAuthorizationpublic 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 AuthenticationExceptionDescription copied from class:AuthenticatorGenerate the authorization header value that will be sent to the server.- Specified by:
- getAuthorizationin class- Authenticator
- 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 java.lang.String getSchemeName() Description copied from class:AuthenticatorGet the authentication method.- Specified by:
- getSchemeNamein class- Authenticator
- Returns:
- the authentication scheme
 
 
- 
 
-