Package io.vertx.mutiny.ext.auth.authentication

Class AuthenticationProvider

java.lang.Object

io.vertx.mutiny.ext.auth.authentication.AuthenticationProvider

Direct Known Subclasses:

AuthProvider, ChainAuth, HtdigestAuth, HtpasswdAuth, JDBCAuthentication, JWTAuth, LdapAuthentication, MongoAuthentication, OAuth2Auth, PropertyFileAuthentication, SqlAuthentication, WebAuthn

public class AuthenticationProvider
extends Object

User-facing interface for authenticating users.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<AuthenticationProvider>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
AuthenticationProvider(io.vertx.ext.auth.authentication.AuthenticationProvider delegate)
AuthenticationProvider(Object delegate)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<User>	authenticate(io.vertx.core.json.JsonObject credentials)	Authenticate a user.
io.smallrye.mutiny.Uni<User>	authenticate(io.vertx.ext.auth.authentication.Credentials credentials)	Authenticate a user.
User	authenticateAndAwait(io.vertx.core.json.JsonObject credentials)	Blocking variant of authenticate(JsonObject).
User	authenticateAndAwait(io.vertx.ext.auth.authentication.Credentials credentials)	Blocking variant of authenticate(Credentials).
void	authenticateAndForget(io.vertx.core.json.JsonObject credentials)	Variant of authenticate(JsonObject) that ignores the result of the operation.
void	authenticateAndForget(io.vertx.ext.auth.authentication.Credentials credentials)	Variant of authenticate(Credentials) that ignores the result of the operation.
boolean	equals(Object o)
io.vertx.ext.auth.authentication.AuthenticationProvider	getDelegate()
int	hashCode()
static AuthenticationProvider	newInstance(io.vertx.ext.auth.authentication.AuthenticationProvider arg)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<AuthenticationProvider> __TYPE_ARG

Constructor Detail

AuthenticationProvider

public AuthenticationProvider(io.vertx.ext.auth.authentication.AuthenticationProvider delegate)

AuthenticationProvider

public AuthenticationProvider(Object delegate)

Method Detail

getDelegate

public io.vertx.ext.auth.authentication.AuthenticationProvider getDelegate()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

authenticate

public io.smallrye.mutiny.Uni<User> authenticate(io.vertx.core.json.JsonObject credentials)

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 object is passed to the handler in an . The user object can then be used for authorisation.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

credentials - The credentials

Returns:

the uni firing the result of the operation when completed, or a failure if the operation failed.

authenticateAndAwait

public User authenticateAndAwait(io.vertx.core.json.JsonObject credentials)

Blocking variant of authenticate(JsonObject).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

credentials - The credentials

Returns:

the User instance produced by the operation.

authenticateAndForget

public void authenticateAndForget(io.vertx.core.json.JsonObject credentials)

Variant of authenticate(JsonObject) that ignores the result of the operation.

This method subscribes on the result of authenticate(JsonObject), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from authenticate(JsonObject) but you don't need to compose it with other operations.

Parameters:

credentials - The credentials

authenticate

public io.smallrye.mutiny.Uni<User> authenticate(io.vertx.ext.auth.authentication.Credentials credentials)

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 object is passed to the handler in an . The user object can then be used for authorisation.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

credentials - The credentials

Returns:

the uni firing the result of the operation when completed, or a failure if the operation failed.

authenticateAndAwait

public User authenticateAndAwait(io.vertx.ext.auth.authentication.Credentials credentials)

Blocking variant of authenticate(Credentials).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

credentials - The credentials

Returns:

the User instance produced by the operation.

authenticateAndForget

public void authenticateAndForget(io.vertx.ext.auth.authentication.Credentials credentials)

Variant of authenticate(Credentials) that ignores the result of the operation.

This method subscribes on the result of authenticate(Credentials), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from authenticate(Credentials) but you don't need to compose it with other operations.

Parameters:

credentials - The credentials

newInstance

public static AuthenticationProvider newInstance(io.vertx.ext.auth.authentication.AuthenticationProvider arg)