io.vertx.rxjava.ext.web.handler

Class DigestAuthHandler

java.lang.Object

io.vertx.rxjava.ext.web.handler.DigestAuthHandler

All Implemented Interfaces:

Handler<RoutingContext>, AuthenticationHandler

public class DigestAuthHandler
extends Object
implements AuthenticationHandler, Handler<RoutingContext>

An auth handler that provides HTTP Basic Authentication support.

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

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<DigestAuthHandler>	__TYPE_ARG
static long	DEFAULT_NONCE_EXPIRE_TIMEOUT The default nonce expire timeout to use in milliseconds.

Constructor Summary

Constructors

Constructor and Description
DigestAuthHandler(DigestAuthHandler delegate)
DigestAuthHandler(Object delegate)

Method Summary

Modifier and Type	Method and Description
String	authenticateHeader(RoutingContext context) Returns
static DigestAuthHandler	create(Vertx vertx, HtdigestAuth authProvider) Create a digest auth handler
static DigestAuthHandler	create(Vertx vertx, HtdigestAuth authProvider, long nonceExpireTimeout) Create a digest auth handler, specifying the expire timeout for nonces.
boolean	equals(Object o)
DigestAuthHandler	getDelegate()
void	handle(RoutingContext event) Something has happened, so handle it.
int	hashCode()
static DigestAuthHandler	newInstance(DigestAuthHandler arg)
void	parseCredentials(RoutingContext context) Parses the credentials from the request into a JsonObject.
void	parseCredentials(RoutingContext context, Handler<AsyncResult<Credentials>> handler) Parses the credentials from the request into a JsonObject.
void	postAuthentication(RoutingContext ctx) This method is called to perform any post authentication tasks, such as redirects.
Single<Credentials>	rxParseCredentials(RoutingContext context) Parses the credentials from the request into a JsonObject.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.rxjava.ext.web.handler.AuthenticationHandler

newInstance

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<DigestAuthHandler> __TYPE_ARG

DEFAULT_NONCE_EXPIRE_TIMEOUT

public static final long DEFAULT_NONCE_EXPIRE_TIMEOUT

The default nonce expire timeout to use in milliseconds.

See Also:

Constant Field Values

Constructor Detail

DigestAuthHandler

public DigestAuthHandler(DigestAuthHandler delegate)

DigestAuthHandler

public DigestAuthHandler(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public DigestAuthHandler getDelegate()

Specified by:

getDelegate in interface AuthenticationHandler

handle

public void handle(RoutingContext event)

Something has happened, so handle it.

Specified by:

handle in interface Handler<RoutingContext>

Specified by:

handle in interface AuthenticationHandler

Parameters:

event - the event to handle

authenticateHeader

public String authenticateHeader(RoutingContext context)

Returns

Specified by:

authenticateHeader in interface AuthenticationHandler

Parameters:

context -

Returns:

postAuthentication

public void postAuthentication(RoutingContext ctx)

This method is called to perform any post authentication tasks, such as redirects. Overrides must call context.next() on success.

Specified by:

postAuthentication in interface AuthenticationHandler

Parameters:

ctx - the routing context

create

public static DigestAuthHandler create(Vertx vertx,
                                       HtdigestAuth authProvider)

Create a digest auth handler

Parameters:

vertx - the vertx instance

authProvider - the auth provider to use

Returns:

the auth handler

create

public static DigestAuthHandler create(Vertx vertx,
                                       HtdigestAuth authProvider,
                                       long nonceExpireTimeout)

Create a digest auth handler, specifying the expire timeout for nonces.

Parameters:

vertx - the vertx instance

authProvider - the auth service to use

nonceExpireTimeout - the nonce expire timeout in milliseconds.

Returns:

the auth handler

parseCredentials

public void parseCredentials(RoutingContext context,
                             Handler<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

public 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

public 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:

newInstance

public static DigestAuthHandler newInstance(DigestAuthHandler arg)