io.vertx.ext.auth.properties.impl

Class PropertyFileAuthenticationImpl

java.lang.Object

io.vertx.ext.auth.properties.impl.PropertyFileAuthenticationImpl

All Implemented Interfaces:

AuthenticationProvider, AuthorizationProvider, PropertyFileAuthentication, PropertyFileAuthorization

public class PropertyFileAuthenticationImpl
extends Object
implements PropertyFileAuthentication, PropertyFileAuthorization

Author:

Stephane Bastian

Constructor Summary

Constructors

Constructor and Description
PropertyFileAuthenticationImpl(Vertx vertx, String path)

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.
void	getAuthorizations(User user, Handler<AsyncResult<Void>> resultHandler) Updates the user with the set of authorizations.
String	getId() returns the id of the authorization provider

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.properties.PropertyFileAuthentication

create

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

authenticate, authenticate

Methods inherited from interface io.vertx.ext.auth.properties.PropertyFileAuthorization

create

Methods inherited from interface io.vertx.ext.auth.authorization.AuthorizationProvider

create, getAuthorizations

Constructor Detail

PropertyFileAuthenticationImpl

public PropertyFileAuthenticationImpl(Vertx vertx,
                                      String path)

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

getId

public String getId()

Description copied from interface: AuthorizationProvider

returns the id of the authorization provider

Specified by:

getId in interface AuthorizationProvider

Returns:

getAuthorizations

public void getAuthorizations(User user,
                              Handler<AsyncResult<Void>> resultHandler)

Description copied from interface: AuthorizationProvider

Updates the user with the set of authorizations.

Specified by:

getAuthorizations in interface AuthorizationProvider

Parameters:

user - user to lookup and update

resultHandler - result handler