Package org.forgerock.am.oauth2

Class AccessTokenResponse

java.lang.Object

org.forgerock.am.oauth2.AccessTokenResponse

@Immutable
public final class AccessTokenResponse
extends Object

Encapsulates the minted access token along with its contextual data.

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AccessTokenResponse.Builder	Access token response builder.

Method Summary

Modifier and Type	Method	Description
static AccessTokenResponse.Builder	builder()	Provides a builder instance to help construct a new access token response.
String	getAccessToken()	Gets the non-null access token.
Duration	getExpiresIn()	Gets the non-null expires in duration which is the actual time in millis when the token will expire.
Set<String>	getScopes()	Gets the scopes associated with the access token.
String	getTokenType()	Gets the non-null token type.

Methods inherited from class java.lang.Object

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

Method Details

getAccessToken

public String getAccessToken()

Gets the non-null access token.

Returns:

the non-null access token

getTokenType

public String getTokenType()

Gets the non-null token type.

Returns:

the non-null token type

getExpiresIn

public Duration getExpiresIn()

Gets the non-null expires in duration which is the actual time in millis when the token will expire.

Returns:

the non-null expires in duration

getScopes

public Set<String> getScopes()

Gets the scopes associated with the access token.

Returns:

the set of scopes associated with the access token

builder

public static AccessTokenResponse.Builder builder()

Provides a builder instance to help construct a new access token response.

Returns:

a builder instance