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

Class OAuth2AuthorizationGrantBuilder

java.lang.Object

com.linecorp.armeria.client.auth.oauth2.OAuth2AuthorizationGrantBuilder

@UnstableApi
public final class OAuth2AuthorizationGrantBuilder
extends Object

A builder for OAuth2AuthorizationGrant which represents an OAuth 2.0 Access Token Grant flow.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizationGrantBuilder	accessTokenRequest(AccessTokenRequest accessTokenRequest)	Sets the AccessTokenRequest to be used when requesting an access token.
OAuth2AuthorizationGrantBuilder	accessTokenRequest(Supplier<AccessTokenRequest> accessTokenRequestSupplier)	Sets the Supplier of AccessTokenRequest to be used when requesting an access token.
OAuth2AuthorizationGrant	build()	Returns a newly created OAuth2AuthorizationGrant based on the configuration set so far.
OAuth2AuthorizationGrantBuilder	fallbackTokenProvider(Supplier<CompletableFuture<? extends GrantedOAuth2AccessToken>> fallbackTokenProvider)	Sets an optional Supplier to acquire an access token before requesting it to the authorization server.
OAuth2AuthorizationGrantBuilder	newTokenConsumer(Consumer<? super GrantedOAuth2AccessToken> newTokenConsumer)	Sets an optional hook which gets executed whenever a new token is issued.
OAuth2AuthorizationGrantBuilder	refreshBefore(Duration refreshBefore)	Sets a period when the token should be refreshed proactively prior to its expiry.
OAuth2AuthorizationGrantBuilder	responseHandler(OAuth2ResponseHandler<GrantedOAuth2AccessToken> responseHandler)	Sets a custom OAuth2ResponseHandler to handle the response of an access token request.

Methods inherited from class java.lang.Object

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

Method Details

accessTokenRequest

public OAuth2AuthorizationGrantBuilder accessTokenRequest(AccessTokenRequest accessTokenRequest)

Sets the AccessTokenRequest to be used when requesting an access token.

Either an AccessTokenRequest or the Supplier of an AccessTokenRequest must be set before building an OAuth2AuthorizationGrant.

accessTokenRequest

public OAuth2AuthorizationGrantBuilder accessTokenRequest(Supplier<AccessTokenRequest> accessTokenRequestSupplier)

Sets the Supplier of AccessTokenRequest to be used when requesting an access token. The supplier will be invoked every time when an access token is requested.

Either an AccessTokenRequest or the Supplier of an AccessTokenRequest must be set before building an OAuth2AuthorizationGrant.

responseHandler

public OAuth2AuthorizationGrantBuilder responseHandler(OAuth2ResponseHandler<GrantedOAuth2AccessToken> responseHandler)

Sets a custom OAuth2ResponseHandler to handle the response of an access token request. If not set, the default response handler will be used.

refreshBefore

public OAuth2AuthorizationGrantBuilder refreshBefore(Duration refreshBefore)

Sets a period when the token should be refreshed proactively prior to its expiry.

fallbackTokenProvider

public OAuth2AuthorizationGrantBuilder fallbackTokenProvider(Supplier<CompletableFuture<? extends GrantedOAuth2AccessToken>> fallbackTokenProvider)

Sets an optional Supplier to acquire an access token before requesting it to the authorization server. If the provided GrantedOAuth2AccessToken is valid, the client doesn't request a new token.

This is supposed to be used with newTokenConsumer(Consumer) and gets executed in the following cases:

• Before the first attempt to acquire an access token.
• Before a subsequent attempt after token issue or refresh failure.

See Also:

• newTokenConsumer(Consumer)

newTokenConsumer

public OAuth2AuthorizationGrantBuilder newTokenConsumer(Consumer<? super GrantedOAuth2AccessToken> newTokenConsumer)

Sets an optional hook which gets executed whenever a new token is issued.

This can be used in combination with fallbackTokenProvider(Supplier) to store a newly issued access token which will then be retrieved by invoking the fallback token provider.

build

public OAuth2AuthorizationGrant build()

Returns a newly created OAuth2AuthorizationGrant based on the configuration set so far.