io.vertx.rxjava.ext.web.handler

Class BasicAuthHandler

java.lang.Object

io.vertx.rxjava.ext.web.handler.BasicAuthHandler

All Implemented Interfaces:

io.vertx.core.Handler<RoutingContext>, AuthHandler

public class BasicAuthHandler
extends Object
implements AuthHandler, io.vertx.core.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 TypeArg<BasicAuthHandler>	__TYPE_ARG
static String	DEFAULT_REALM The default realm to use

Constructor Summary

Constructors

Constructor and Description
BasicAuthHandler(io.vertx.ext.web.handler.BasicAuthHandler delegate)
BasicAuthHandler(Object delegate)

Method Summary

Modifier and Type	Method and Description
AuthHandler	addAuthorities(Set<String> authorities) Add a set of required authorities for this auth handler
AuthHandler	addAuthority(String authority) Add a required authority for this auth handler
void	authorize(User user, io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler) Authorizes the given user against all added authorities.
rx.Observable<Void>	authorizeObservable(User user) Deprecated. use rxAuthorize(io.vertx.rxjava.ext.auth.User) instead
static AuthHandler	create(AuthProvider authProvider) Create a basic auth handler
static AuthHandler	create(AuthProvider authProvider, String realm) Create a basic auth handler, specifying realm
boolean	equals(Object o)
io.vertx.ext.web.handler.BasicAuthHandler	getDelegate()
void	handle(RoutingContext event) Something has happened, so handle it.
int	hashCode()
static BasicAuthHandler	newInstance(io.vertx.ext.web.handler.BasicAuthHandler arg)
void	parseCredentials(RoutingContext context, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.json.JsonObject>> handler) Parses the credentials from the request into a JsonObject.
rx.Observable<io.vertx.core.json.JsonObject>	parseCredentialsObservable(RoutingContext context) Deprecated. use rxParseCredentials(io.vertx.rxjava.ext.web.RoutingContext) instead
rx.Single<Void>	rxAuthorize(User user) Authorizes the given user against all added authorities.
rx.Single<io.vertx.core.json.JsonObject>	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.AuthHandler

newInstance

Field Detail

__TYPE_ARG

public static final TypeArg<BasicAuthHandler> __TYPE_ARG

DEFAULT_REALM

public static final String DEFAULT_REALM

The default realm to use

See Also:

Constant Field Values

Constructor Detail

BasicAuthHandler

public BasicAuthHandler(io.vertx.ext.web.handler.BasicAuthHandler delegate)

BasicAuthHandler

public BasicAuthHandler(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 io.vertx.ext.web.handler.BasicAuthHandler getDelegate()

Specified by:

getDelegate in interface AuthHandler

handle

public void handle(RoutingContext event)

Something has happened, so handle it.

Specified by:

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

Specified by:

handle in interface AuthHandler

Parameters:

event - the event to handle

addAuthority

public AuthHandler addAuthority(String authority)

Add a required authority for this auth handler

Specified by:

addAuthority in interface AuthHandler

Parameters:

authority - the authority

Returns:

a reference to this, so the API can be used fluently

addAuthorities

public AuthHandler addAuthorities(Set<String> authorities)

Add a set of required authorities for this auth handler

Specified by:

addAuthorities in interface AuthHandler

Parameters:

authorities - the set of authorities

Returns:

a reference to this, so the API can be used fluently

parseCredentials

public void parseCredentials(RoutingContext context,
                             io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.json.JsonObject>> 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.

Specified by:

parseCredentials in interface AuthHandler

Parameters:

context - the routing context

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

parseCredentialsObservable

@Deprecated
public rx.Observable<io.vertx.core.json.JsonObject> parseCredentialsObservable(RoutingContext context)

Deprecated. use rxParseCredentials(io.vertx.rxjava.ext.web.RoutingContext) instead

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:

rxParseCredentials

public rx.Single<io.vertx.core.json.JsonObject> 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:

authorize

public void authorize(User user,
                      io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)

Authorizes the given user against all added authorities.

Specified by:

authorize in interface AuthHandler

Parameters:

user - a user.

handler - the handler for the result.

authorizeObservable

@Deprecated
public rx.Observable<Void> authorizeObservable(User user)

Deprecated. use rxAuthorize(io.vertx.rxjava.ext.auth.User) instead

Authorizes the given user against all added authorities.

Parameters:

user - a user.

Returns:

rxAuthorize

public rx.Single<Void> rxAuthorize(User user)

Authorizes the given user against all added authorities.

Parameters:

user - a user.

Returns:

create

public static AuthHandler create(AuthProvider authProvider)

Create a basic auth handler

Parameters:

authProvider - the auth provider to use

Returns:

the auth handler

create

public 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

newInstance

public static BasicAuthHandler newInstance(io.vertx.ext.web.handler.BasicAuthHandler arg)