Class OAuth2AccessTokenResponse.Builder

java.lang.Object

org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Enclosing class:

OAuth2AccessTokenResponse

public static final class OAuth2AccessTokenResponse.Builder
extends Object

A builder for OAuth2AccessTokenResponse.

Since:

5.0

Method Summary

Modifier and Type	Method	Description
OAuth2AccessTokenResponse.Builder	additionalParameters(@Nullable Map<String,Object> additionalParameters)	Sets the additional parameters returned in the response.
OAuth2AccessTokenResponse	build()	Builds a new OAuth2AccessTokenResponse.
OAuth2AccessTokenResponse.Builder	expiresIn(long expiresIn)	Sets the lifetime (in seconds) of the access token.
OAuth2AccessTokenResponse.Builder	refreshToken(@Nullable String refreshToken)	Sets the refresh token associated to the access token.
OAuth2AccessTokenResponse.Builder	scopes(@Nullable Set<String> scopes)	Sets the scope(s) associated to the access token.
OAuth2AccessTokenResponse.Builder	tokenType(@Nullable OAuth2AccessToken.TokenType tokenType)	Sets the token type.

Methods inherited from class Object

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

Method Details

tokenType

public OAuth2AccessTokenResponse.Builder tokenType(@Nullable OAuth2AccessToken.TokenType tokenType)

Sets the token type.

Parameters:

tokenType - the type of token issued, may be null

Returns:

the OAuth2AccessTokenResponse.Builder

expiresIn

public OAuth2AccessTokenResponse.Builder expiresIn(long expiresIn)

Sets the lifetime (in seconds) of the access token.

Parameters:

expiresIn - the lifetime of the access token, in seconds.

Returns:

the OAuth2AccessTokenResponse.Builder

scopes

public OAuth2AccessTokenResponse.Builder scopes(@Nullable Set<String> scopes)

Sets the scope(s) associated to the access token.

Parameters:

scopes - the scope(s) associated to the access token, may be null

Returns:

the OAuth2AccessTokenResponse.Builder

refreshToken

public OAuth2AccessTokenResponse.Builder refreshToken(@Nullable String refreshToken)

Sets the refresh token associated to the access token.

Parameters:

refreshToken - the refresh token associated to the access token, may be null

Returns:

the OAuth2AccessTokenResponse.Builder

additionalParameters

public OAuth2AccessTokenResponse.Builder additionalParameters(@Nullable Map<String,Object> additionalParameters)

Sets the additional parameters returned in the response.

Parameters:

additionalParameters - the additional parameters returned in the response, may be null

Returns:

the OAuth2AccessTokenResponse.Builder

build

public OAuth2AccessTokenResponse build()

Builds a new OAuth2AccessTokenResponse.

Returns:

a OAuth2AccessTokenResponse