Package org.apache.tomcat.websocket

Class 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 
      Modifier Constructor Description
      protected Authenticator()
      Constructs an Authenticator instance.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getAuthorization​(java.lang.String requestUri, java.lang.String authenticateHeader, java.lang.String userName, java.lang.String userPassword, java.lang.String userRealm)
      Deprecated.
      Unused.
      abstract java.lang.String getAuthorization​(java.lang.String method, 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)
      Validates that the password is not null.
      protected void validateRealm​(java.lang.String userRealm, java.lang.String serverRealm)
      Validates that the configured user realm matches the server realm.
      protected void validateUsername​(java.lang.String userName)
      Validates that the user name is not null.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Authenticator

        protected Authenticator()
        Constructs an Authenticator instance.

    • Method Detail

      • getAuthorization

        @Deprecated
public 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
        Deprecated.
        Unused. Will be remove in Tomcat 12. Use getAuthorization(String, String, String, String, String, String)
        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 username
        userPassword - The user password
        userRealm - 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

      • getAuthorization

        public abstract java.lang.String getAuthorization​(java.lang.String method,
                                                  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:
        method - The request method
        requestUri - The request URI
        authenticateHeader - The server authentication header received
        userName - The username
        userPassword - The user password
        userRealm - 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
        Validates that the user name is not null.
        Parameters:
        userName - the user name to validate
        Throws:
        AuthenticationException - if the user name is null

      • validatePassword

        protected void validatePassword​(java.lang.String password)
                         throws AuthenticationException
        Validates that the password is not null.
        Parameters:
        password - the password to validate
        Throws:
        AuthenticationException - if the password is null

      • validateRealm

        protected void validateRealm​(java.lang.String userRealm,
                             java.lang.String serverRealm)
                      throws AuthenticationException
        Validates that the configured user realm matches the server realm.
        Parameters:
        userRealm - the user-configured realm, or null to accept any realm
        serverRealm - the realm from the server's authentication challenge
        Throws:
        AuthenticationException - if the realms do not match