public interface AuthenticationProvider
Modifier and Type | Method and Description |
---|---|
default Future<User> |
authenticate(Credentials credentials)
Authenticate a user.
|
default void |
authenticate(Credentials credentials,
Handler<AsyncResult<User>> resultHandler)
Authenticate a user.
|
default Future<User> |
authenticate(JsonObject credentials)
Deprecated.
For type safety this method should be avoided and
authenticate(Credentials) should be
used instead. |
void |
authenticate(JsonObject credentials,
Handler<AsyncResult<User>> resultHandler)
Deprecated.
For type safety this method should be avoided and
authenticate(Credentials, Handler) should be
used instead. |
@Deprecated void authenticate(JsonObject credentials, Handler<AsyncResult<User>> resultHandler)
authenticate(Credentials, Handler)
should be
used instead.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.
credentials
- The credentialsresultHandler
- The result handler@Deprecated default Future<User> authenticate(JsonObject credentials)
authenticate(Credentials)
should be
used instead.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.
credentials
- The credentialsauthenticate(JsonObject, Handler)
default void authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler)
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.
credentials
- The credentialsresultHandler
- The result handlerdefault Future<User> authenticate(Credentials credentials)
The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.
credentials
- The credentialsauthenticate(Credentials, Handler)
Copyright © 2023 Eclipse. All rights reserved.