io.vertx.ext.auth.jwt.impl

Class JWTAuthProviderImpl

java.lang.Object

io.vertx.ext.auth.jwt.impl.JWTAuthProviderImpl

All Implemented Interfaces:

AuthenticationProvider, JWTAuth

public class JWTAuthProviderImpl
extends Object
implements JWTAuth

Author:

Paulo Lopes

Constructor Summary

Constructors

Constructor and Description
JWTAuthProviderImpl(Vertx vertx, JWTAuthOptions config)

Method Summary

Modifier and Type	Method and Description
void	authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler) Authenticate a user.
void	authenticate(JsonObject authInfo, Handler<AsyncResult<User>> resultHandler) Authenticate a user.
String	generateToken(JsonObject claims) Generate a new JWT token.
String	generateToken(JsonObject claims, JWTOptions options) Generate a new JWT token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.ext.auth.jwt.JWTAuth

create

Methods inherited from interface io.vertx.ext.auth.authentication.AuthenticationProvider

authenticate, authenticate

Constructor Detail

JWTAuthProviderImpl

public JWTAuthProviderImpl(Vertx vertx,
                           JWTAuthOptions config)

Method Detail

authenticate

public void authenticate(JsonObject authInfo,
                         Handler<AsyncResult<User>> resultHandler)

Description copied from interface: AuthenticationProvider

Authenticate a user.

The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:

   {
     "username": "tim",
     "password": "mypassword"
   }
 

For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authInfo - The credentials

resultHandler - The result handler

authenticate

public void authenticate(Credentials credentials,
                         Handler<AsyncResult<User>> resultHandler)

Description copied from interface: AuthenticationProvider

Authenticate a user.

The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation. If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

credentials - The credentials

resultHandler - The result handler

generateToken

public String generateToken(JsonObject claims,
                            JWTOptions options)

Description copied from interface: JWTAuth

Generate a new JWT token.

Specified by:

generateToken in interface JWTAuth

Parameters:

claims - Json with user defined claims for a list of official claims

options - extra options for the generation

Returns:

JWT encoded token

See Also:

www.iana.org/assignments/jwt/jwt.xhtml

generateToken

public String generateToken(JsonObject claims)

Description copied from interface: JWTAuth

Generate a new JWT token.

Specified by:

generateToken in interface JWTAuth

Parameters:

claims - Json with user defined claims for a list of official claims

Returns:

JWT encoded token

See Also:

www.iana.org/assignments/jwt/jwt.xhtml