io.vertx.ext.auth.htdigest.impl

Class HtdigestAuthImpl

java.lang.Object

io.vertx.ext.auth.htdigest.impl.HtdigestAuthImpl

All Implemented Interfaces:

AuthenticationProvider, HtdigestAuth

public class HtdigestAuthImpl
extends Object
implements HtdigestAuth

An implementation of HtdigestAuth

Author:

Paulo Lopes

Field Summary

Fields inherited from interface io.vertx.ext.auth.htdigest.HtdigestAuth

HTDIGEST_FILE

Constructor Summary

Constructors

Constructor and Description
HtdigestAuthImpl(Vertx vertx, String htdigestFile) Creates a new instance

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	realm() Return the currently used realm

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.htdigest.HtdigestAuth

create, create

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

authenticate, authenticate

Constructor Detail

HtdigestAuthImpl

public HtdigestAuthImpl(Vertx vertx,
                        String htdigestFile)

Creates a new instance

Method Detail

realm

public String realm()

Description copied from interface: HtdigestAuth

Return the currently used realm

Specified by:

realm in interface HtdigestAuth

Returns:

the realm

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