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 Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static java.lang.String` | `charsetparam` |
    `static java.lang.String` | `schemeName` |

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `BasicAuthenticator()` |

  - ### Method Summary

    All Methods Instance Methods Concrete 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)` | Generate the authorization header value that will be sent to the server.
    `java.lang.String` | `getSchemeName()` | Get the authentication method.

    - ### Methods inherited from class org.apache.tomcat.websocket.Authenticator

      `getAuthorization, parseAuthenticateHeader, parseWWWAuthenticateHeader, validatePassword, validateRealm, validateUsername`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### schemeName

          public static final java.lang.String schemeName

      See Also:
        Constant Field Values

    - #### charsetparam

          public static final java.lang.String charsetparam

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### BasicAuthenticator

          public BasicAuthenticator()

  - ### Method Detail

    - #### getAuthorization

          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

      Description copied from class: `Authenticator`
      Generate the authorization header value that will be sent to the server.
      Specified by:
        `getAuthorization` in 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. `null` to indicate all realms.
      Returns:
        The generated authorization header value
      Throws:
        `AuthenticationException` - When an error occurs

    - #### getSchemeName

          public java.lang.String getSchemeName()

      Description copied from class: `Authenticator`
      Get the authentication method.
      Specified by:
        `getSchemeName` in class `Authenticator`
      Returns:
        the authentication scheme