io.vertx.ext.web.handler

## Interface BasicAuthHandler

- All Superinterfaces:
    AuthHandler, Handler<RoutingContext>

      public interface BasicAuthHandler
      extends AuthHandler

  An auth handler that provides HTTP Basic Authentication support.
  Author:
    Tim Fox

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `DEFAULT_REALM` The default realm to use

  - ### Method Summary

    All Methods Static Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `static AuthHandler` | `create(AuthProvider authProvider)` Create a basic auth handler
    `static AuthHandler` | `create(AuthProvider authProvider, String realm)` Create a basic auth handler, specifying realm

    - ### Methods inherited from interface io.vertx.ext.web.handler.AuthHandler

      `addAuthorities, addAuthority, authorize, parseCredentials`

    - ### Methods inherited from interface io.vertx.core.Handler

      `handle`

- - ### Field Detail

    - #### DEFAULT_REALM

          static final String DEFAULT_REALM

      The default realm to use
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### create

          static AuthHandler create(AuthProvider authProvider)

      Create a basic auth handler
      Parameters:
        `authProvider` - the auth provider to use
      Returns:
        the auth handler

    - #### create

          static AuthHandler create(AuthProvider authProvider,
                                    String realm)

      Create a basic auth handler, specifying realm
      Parameters:
        `authProvider` - the auth service to use
        `realm` - the realm to use
      Returns:
        the auth handler

Copyright © 2021 Eclipse. All rights reserved.