Module io.vertx.web

Package io.vertx.ext.web.handler

Interface BasicAuthHandler

All Superinterfaces:

AuthenticationHandler, Handler<RoutingContext>

public interface BasicAuthHandler
extends AuthenticationHandler

An auth handler that provides HTTP Basic Authentication support.

Author:

Tim Fox

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_REALM	The default realm to use

Method Summary

Static Methods

Modifier and Type	Method	Description
static BasicAuthHandler	create(AuthenticationProvider authProvider)	Create a basic auth handler
static BasicAuthHandler	create(AuthenticationProvider authProvider, String realm)	Create a basic auth handler, specifying realm

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 BasicAuthHandler create(AuthenticationProvider authProvider)

Create a basic auth handler

Parameters:

authProvider - the auth provider to use

Returns:

the auth handler

create

static BasicAuthHandler create(AuthenticationProvider 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