io.vertx.rxjava.ext.web.handler

Interface AuthenticationHandler

All Superinterfaces:

io.vertx.core.Handler<RoutingContext>

All Known Subinterfaces:

AuthHandler

All Known Implementing Classes:

BasicAuthHandler, ChainAuthHandler, DigestAuthHandler, JWTAuthHandler, OAuth2AuthHandler, RedirectAuthHandler

public interface AuthenticationHandler
extends io.vertx.core.Handler<RoutingContext>

Base interface for auth handlers.

An auth handler allows your application to provide authentication/authorization support.

Auth handler requires a SessionHandler to be on the routing chain before it.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Method Summary

Modifier and Type	Method and Description
String	authenticateHeader(RoutingContext context) Returns
io.vertx.ext.web.handler.AuthenticationHandler	getDelegate()
void	handle(RoutingContext event) Something has happened, so handle it.
static AuthenticationHandler	newInstance(io.vertx.ext.web.handler.AuthenticationHandler arg)
void	parseCredentials(RoutingContext context) Parses the credentials from the request into a JsonObject.
void	parseCredentials(RoutingContext context, io.vertx.core.Handler<io.vertx.core.AsyncResult<Credentials>> handler) Parses the credentials from the request into a JsonObject.
rx.Single<Credentials>	rxParseCredentials(RoutingContext context) Parses the credentials from the request into a JsonObject.

Method Detail

getDelegate

io.vertx.ext.web.handler.AuthenticationHandler getDelegate()

handle

void handle(RoutingContext event)

Something has happened, so handle it.

Specified by:

handle in interface io.vertx.core.Handler<RoutingContext>

Parameters:

event - the event to handle

parseCredentials

void parseCredentials(RoutingContext context,
                      io.vertx.core.Handler<io.vertx.core.AsyncResult<Credentials>> handler)

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Parameters:

context - the routing context

handler - the handler to be called once the information is available.

parseCredentials

void parseCredentials(RoutingContext context)

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Parameters:

context - the routing context

rxParseCredentials

rx.Single<Credentials> rxParseCredentials(RoutingContext context)

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Parameters:

context - the routing context

Returns:

authenticateHeader

String authenticateHeader(RoutingContext context)

Returns

Parameters:

context -

Returns:

newInstance

static AuthenticationHandler newInstance(io.vertx.ext.web.handler.AuthenticationHandler arg)