Package com.linecorp.armeria.client.auth.oauth2

Class OAuth2Client

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<HttpRequest,HttpResponse>

com.linecorp.armeria.client.SimpleDecoratingHttpClient

com.linecorp.armeria.client.auth.oauth2.OAuth2Client

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

@UnstableApi
public final class OAuth2Client
extends SimpleDecoratingHttpClient

Decorates a HttpClient with an OAuth 2.0 Authorization Grant flow.

Method Summary

Modifier and Type	Method	Description
HttpResponse	execute(ClientRequestContext ctx, HttpRequest req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
static Function<? super HttpClient,OAuth2Client>	newDecorator(OAuth2AuthorizationGrant authorizationGrant)	Creates a new HttpClient decorator that handles OAuth 2.0 Authorization Grant flow.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super HttpClient,OAuth2Client> newDecorator(OAuth2AuthorizationGrant authorizationGrant)

Creates a new HttpClient decorator that handles OAuth 2.0 Authorization Grant flow.

Parameters:

authorizationGrant - An OAuth2AuthorizationGrant implementing specific OAuth 2.0 Authorization Grant flow.

execute

public HttpResponse execute(ClientRequestContext ctx,
 HttpRequest req)
                     throws Exception

Description copied from interface: Client

Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().

Returns:

the Response to the specified Request

Throws:

Exception