public class AuthProvider extends Object
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<AuthProvider> |
__TYPE_ARG |
Constructor and Description |
---|
AuthProvider(AuthProvider delegate) |
AuthProvider(Object delegate) |
Modifier and Type | Method and Description |
---|---|
void |
authenticate(JsonObject authInfo,
Handler<AsyncResult<User>> resultHandler)
Authenticate a user.
|
boolean |
equals(Object o) |
AuthProvider |
getDelegate() |
int |
hashCode() |
static AuthProvider |
newInstance(AuthProvider arg) |
Single<User> |
rxAuthenticate(JsonObject authInfo)
Authenticate a user.
|
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<AuthProvider> __TYPE_ARG
public AuthProvider(AuthProvider delegate)
public AuthProvider(Object delegate)
public AuthProvider getDelegate()
public void authenticate(JsonObject authInfo, Handler<AsyncResult<User>> resultHandler)
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.
authInfo
- The auth informationresultHandler
- The result handlerpublic Single<User> rxAuthenticate(JsonObject authInfo)
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.
authInfo
- The auth informationpublic static AuthProvider newInstance(AuthProvider arg)
Copyright © 2023 Eclipse. All rights reserved.