io.vertx.rxjava.ext.web.handler

Class JWTAuthHandler

java.lang.Object

io.vertx.rxjava.ext.web.handler.JWTAuthHandler

All Implemented Interfaces:

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

public class JWTAuthHandler
extends Object
implements AuthHandler, io.vertx.core.Handler<RoutingContext>

An auth handler that provides JWT 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<JWTAuthHandler>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
JWTAuthHandler(io.vertx.ext.web.handler.JWTAuthHandler delegate)
JWTAuthHandler(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 JWTAuthHandler	create(JWTAuth authProvider) Create a JWT auth handler
static JWTAuthHandler	create(JWTAuth authProvider, String skip) Create a JWT auth handler
boolean	equals(Object o)
io.vertx.ext.web.handler.JWTAuthHandler	getDelegate()
void	handle(RoutingContext event) Something has happened, so handle it.
int	hashCode()
static JWTAuthHandler	newInstance(io.vertx.ext.web.handler.JWTAuthHandler 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.
JWTAuthHandler	setAudience(List<String> audience) Set the audience list
JWTAuthHandler	setIgnoreExpiration(boolean ignoreExpiration) Set whether expiration is ignored
JWTAuthHandler	setIssuer(String issuer) Set the issuer
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 io.vertx.lang.rx.TypeArg<JWTAuthHandler> __TYPE_ARG

Constructor Detail

JWTAuthHandler

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

JWTAuthHandler

public JWTAuthHandler(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.JWTAuthHandler 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 JWTAuthHandler create(JWTAuth authProvider)

Create a JWT auth handler

Parameters:

authProvider - the auth provider to use

Returns:

the auth handler

create

public static JWTAuthHandler create(JWTAuth authProvider,
                                    String skip)

Create a JWT auth handler

Parameters:

authProvider - the auth provider to use.

skip -

Returns:

the auth handler

setAudience

public JWTAuthHandler setAudience(List<String> audience)

Set the audience list

Parameters:

audience - the audience list

Returns:

a reference to this for fluency

setIssuer

public JWTAuthHandler setIssuer(String issuer)

Set the issuer

Parameters:

issuer - the issuer

Returns:

a reference to this for fluency

setIgnoreExpiration

public JWTAuthHandler setIgnoreExpiration(boolean ignoreExpiration)

Set whether expiration is ignored

Parameters:

ignoreExpiration - whether expiration is ignored

Returns:

a reference to this for fluency

newInstance

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