Package com.linecorp.armeria.common.auth.oauth2

Class GrantedOAuth2AccessTokenBuilder

java.lang.Object

com.linecorp.armeria.common.auth.oauth2.GrantedOAuth2AccessTokenBuilder

@UnstableApi
public final class GrantedOAuth2AccessTokenBuilder
extends Object

Builds an instance of GrantedOAuth2AccessToken.

Method Summary

Modifier and Type	Method	Description
GrantedOAuth2AccessToken	build()	Builds a new instance of GrantedOAuth2AccessToken based on the configured parameters.
GrantedOAuth2AccessTokenBuilder	expiresIn(Duration expiresIn)	"expires_in" Access Token response field, RECOMMENDED.
GrantedOAuth2AccessTokenBuilder	extras(Iterable<? extends Map.Entry<String,String>> extras)	An Iterable of extra system-specific token parameters included with Access Token Response, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	extras(String key, String value)	A pair of extra system-specific token parameters included with Access Token Response, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	extras(Map<String,String> extras)	A Map of extra system-specific token parameters included with Access Token Response, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	issuedAt(Instant issuedAt)	An Instant indicating when the Access Token was issued, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	refreshToken(String refreshToken)	"refresh_token" Access Token response field, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	scope(Iterable<String> scope)	"scope" Access Token Response field, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	scope(String... scope)	"scope" Access Token Response field, OPTIONAL.
GrantedOAuth2AccessTokenBuilder	tokenType(String tokenType)	"token_type" Access Token response field, REQUIRED.

Methods inherited from class java.lang.Object

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

Method Details

tokenType

public GrantedOAuth2AccessTokenBuilder tokenType(String tokenType)

"token_type" Access Token response field, REQUIRED. The type of the token issued as described at [RFC6749], Section 7.1. Value is case insensitive.

expiresIn

public GrantedOAuth2AccessTokenBuilder expiresIn(Duration expiresIn)

"expires_in" Access Token response field, RECOMMENDED. Duration indicating the lifetime of the access token. For example, the value 3600 seconds denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

issuedAt

public GrantedOAuth2AccessTokenBuilder issuedAt(Instant issuedAt)

An Instant indicating when the Access Token was issued, OPTIONAL. The value is NOT supplied with the Access Token response and calculated approximately using "expires_in" field.

refreshToken

public GrantedOAuth2AccessTokenBuilder refreshToken(String refreshToken)

"refresh_token" Access Token response field, OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described at [RFC6749], Section 6.

scope

public GrantedOAuth2AccessTokenBuilder scope(Iterable<String> scope)

"scope" Access Token Response field, OPTIONAL. An Iterable of individual scope values.

scope

public GrantedOAuth2AccessTokenBuilder scope(String... scope)

"scope" Access Token Response field, OPTIONAL. An array of individual scope values.

extras

public GrantedOAuth2AccessTokenBuilder extras(String key,
 String value)

A pair of extra system-specific token parameters included with Access Token Response, OPTIONAL.

extras

public GrantedOAuth2AccessTokenBuilder extras(Map<String,String> extras)

A Map of extra system-specific token parameters included with Access Token Response, OPTIONAL.

extras

public GrantedOAuth2AccessTokenBuilder extras(Iterable<? extends Map.Entry<String,String>> extras)

An Iterable of extra system-specific token parameters included with Access Token Response, OPTIONAL.

build

public GrantedOAuth2AccessToken build()

Builds a new instance of GrantedOAuth2AccessToken based on the configured parameters.