Package io.vertx.mutiny.ext.auth.oauth2.providers

Class KeycloakAuth

java.lang.Object

io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth

io.vertx.mutiny.ext.auth.oauth2.providers.KeycloakAuth

public class KeycloakAuth
extends OpenIDConnectAuth

Simplified factory to create an for Keycloak.

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<KeycloakAuth>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
KeycloakAuth(io.vertx.ext.auth.oauth2.providers.KeycloakAuth delegate)
KeycloakAuth(Object delegate)

Method Summary

Modifier and Type	Method	Description
static OAuth2Auth	create(Vertx vertx, io.vertx.core.json.JsonObject config)
static OAuth2Auth	create(Vertx vertx, io.vertx.core.json.JsonObject config, io.vertx.core.http.HttpClientOptions httpClientOptions)
static OAuth2Auth	create(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2FlowType flow, io.vertx.core.json.JsonObject config)
static OAuth2Auth	create(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2FlowType flow, io.vertx.core.json.JsonObject config, io.vertx.core.http.HttpClientOptions httpClientOptions)
static io.smallrye.mutiny.Uni<OAuth2Auth>	discover(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)	Create a OAuth2Auth provider for OpenID Connect Discovery.
static OAuth2Auth	discoverAndAwait(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)	Blocking variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options).
static void	discoverAndForget(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)	Variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options) that ignores the result of the operation.
boolean	equals(Object o)
io.vertx.ext.auth.oauth2.providers.KeycloakAuth	getDelegate()
int	hashCode()
static KeycloakAuth	newInstance(io.vertx.ext.auth.oauth2.providers.KeycloakAuth arg)
String	toString()

Methods inherited from class io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth

newInstance

Methods inherited from class java.lang.Object

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

Field Detail

__TYPE_ARG

public static final TypeArg<KeycloakAuth> __TYPE_ARG

Constructor Detail

KeycloakAuth

public KeycloakAuth(io.vertx.ext.auth.oauth2.providers.KeycloakAuth delegate)

KeycloakAuth

public KeycloakAuth(Object delegate)

Method Detail

getDelegate

public io.vertx.ext.auth.oauth2.providers.KeycloakAuth getDelegate()

Overrides:

getDelegate in class OpenIDConnectAuth

toString

public String toString()

Overrides:

toString in class OpenIDConnectAuth

equals

public boolean equals(Object o)

Overrides:

equals in class OpenIDConnectAuth

hashCode

public int hashCode()

Overrides:

hashCode in class OpenIDConnectAuth

create

public static OAuth2Auth create(Vertx vertx,
                                io.vertx.core.json.JsonObject config)

Parameters:

vertx -

config - the json config file exported from Keycloak admin console

Returns:

create

public static OAuth2Auth create(Vertx vertx,
                                io.vertx.ext.auth.oauth2.OAuth2FlowType flow,
                                io.vertx.core.json.JsonObject config)

Parameters:

vertx -

flow - the oauth2 flow to use

config - the json config file exported from Keycloak admin console

Returns:

create

public static OAuth2Auth create(Vertx vertx,
                                io.vertx.core.json.JsonObject config,
                                io.vertx.core.http.HttpClientOptions httpClientOptions)

Parameters:

vertx -

config - the json config file exported from Keycloak admin console

httpClientOptions - custom http client options

Returns:

create

public static OAuth2Auth create(Vertx vertx,
                                io.vertx.ext.auth.oauth2.OAuth2FlowType flow,
                                io.vertx.core.json.JsonObject config,
                                io.vertx.core.http.HttpClientOptions httpClientOptions)

Parameters:

vertx -

flow - the oauth2 flow to use

config - the json config file exported from Keycloak admin console

httpClientOptions - custom http client options

Returns:

discover

@CheckReturnValue
public static io.smallrye.mutiny.Uni<OAuth2Auth> discover(Vertx vertx,
                                                          io.vertx.ext.auth.oauth2.OAuth2Options config)

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

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

Parameters:

vertx - the vertx instance

config - the initial config

Returns:

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

discoverAndAwait

public static OAuth2Auth discoverAndAwait(Vertx vertx,
                                          io.vertx.ext.auth.oauth2.OAuth2Options config)

Blocking variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options).

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:

vertx - the vertx instance

config - the initial config

Returns:

the OAuth2Auth instance produced by the operation.

discoverAndForget

public static void discoverAndForget(Vertx vertx,
                                     io.vertx.ext.auth.oauth2.OAuth2Options config)

Variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options) that ignores the result of the operation.

This method subscribes on the result of discover(io.vertx.mutiny.core.Vertx,OAuth2Options), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from discover(io.vertx.mutiny.core.Vertx,OAuth2Options) but you don't need to compose it with other operations.

Parameters:

vertx - the vertx instance

config - the initial config

newInstance

public static KeycloakAuth newInstance(io.vertx.ext.auth.oauth2.providers.KeycloakAuth arg)