Package io.vertx.mutiny.ext.web.client

Class OAuth2WebClient

java.lang.Object

io.vertx.mutiny.ext.web.client.WebClient

io.vertx.mutiny.ext.web.client.OAuth2WebClient

public class OAuth2WebClient
extends WebClient

An asynchronous OAuth2/OIDC aware HTTP / HTTP/2 client called WebClientOAuth2.

This client wraps a WebClient and makes it session aware adding features to it:

• Request an access_token if no user is created
• Refresh access_token if current user is expired

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

Constructor Summary

Constructors

Constructor	Description
OAuth2WebClient(io.vertx.ext.web.client.OAuth2WebClient delegate)
OAuth2WebClient(Object delegate)

Method Summary

Modifier and Type	Method	Description
static OAuth2WebClient	create(WebClient webClient, OAuth2Auth oAuth2Auth)
static OAuth2WebClient	create(WebClient webClient, OAuth2Auth oAuth2Auth, io.vertx.ext.web.client.OAuth2WebClientOptions options)
boolean	equals(Object o)
io.vertx.ext.web.client.OAuth2WebClient	getDelegate()
User	getUser()
int	hashCode()
static OAuth2WebClient	newInstance(io.vertx.ext.web.client.OAuth2WebClient arg)
String	toString()
OAuth2WebClient	withCredentials(io.vertx.ext.auth.authentication.Credentials credentials)

Methods inherited from class io.vertx.mutiny.ext.web.client.WebClient

close, create, create, delete, delete, delete, delete, delete, delete, deleteAbs, deleteAbs, get, get, get, get, get, get, getAbs, getAbs, head, head, head, head, head, head, headAbs, headAbs, newInstance, patch, patch, patch, patch, patch, patch, patchAbs, patchAbs, post, post, post, post, post, post, postAbs, postAbs, put, put, put, put, put, put, putAbs, putAbs, request, request, request, request, request, request, request, request, request, request, request, request, request, request, requestAbs, requestAbs, requestAbs, requestAbs, updateSSLOptions, updateSSLOptions, updateSSLOptionsAndAwait, updateSSLOptionsAndAwait, updateSSLOptionsAndForget, updateSSLOptionsAndForget, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

__TYPE_ARG

public static final TypeArg<OAuth2WebClient> __TYPE_ARG

Constructor Detail

OAuth2WebClient

public OAuth2WebClient(io.vertx.ext.web.client.OAuth2WebClient delegate)

OAuth2WebClient

public OAuth2WebClient(Object delegate)

Method Detail

getDelegate

public io.vertx.ext.web.client.OAuth2WebClient getDelegate()

Overrides:

getDelegate in class WebClient

toString

public String toString()

Overrides:

toString in class WebClient

equals

public boolean equals(Object o)

Overrides:

equals in class WebClient

hashCode

public int hashCode()

Overrides:

hashCode in class WebClient

create

public static OAuth2WebClient create(WebClient webClient,
                                     OAuth2Auth oAuth2Auth)

Parameters:

webClient - the web client instance

oAuth2Auth - Configured oAuth2Auth provider to be used when withCredentials(io.vertx.ext.auth.authentication.Credentials) used

Returns:

the created client

create

public static OAuth2WebClient create(WebClient webClient,
                                     OAuth2Auth oAuth2Auth,
                                     io.vertx.ext.web.client.OAuth2WebClientOptions options)

Parameters:

webClient - the web client instance

oAuth2Auth - Configured oAuth2Auth provider to be used when withCredentials(io.vertx.ext.auth.authentication.Credentials) used

options - extra configuration for this object

Returns:

the created client

getUser

public User getUser()

Returns:

the current user associated with this client or null if no user is associated

withCredentials

public OAuth2WebClient withCredentials(io.vertx.ext.auth.authentication.Credentials credentials)

Parameters:

credentials -

Returns:

a reference to this, so the API can be used fluently

newInstance

public static OAuth2WebClient newInstance(io.vertx.ext.web.client.OAuth2WebClient arg)