Package org.forgerock.am.oauth2

Class AccessTokenRequest

java.lang.Object

org.forgerock.am.oauth2.AccessTokenRequest

@Immutable
public final class AccessTokenRequest
extends Object

Encapsulates all relevant data necessary to represent a request for a new access token.

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AccessTokenRequest.Builder	Access token request builder.
static enum	AccessTokenRequest.GrantType

Method Summary

Modifier and Type	Method	Description
static AccessTokenRequest.Builder	builder()	Provides a builder instance to help construct a new access token request.
String	getClientId()	Gets the non-null OAuth2 client id.
String	getClientSecret()	Gets the non-null OAuth2 client secret.
AccessTokenRequest.GrantType	getGrantType()
Realm	getRealm()	Gets the non-null realm context in which an access token should be produced.
Request	getRequest()	Gets the original Request that prompted this request for an access token.
Set<String>	getScopes()	Gets the non-null available set of scopes.
String	getSubject()

Methods inherited from class java.lang.Object

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

Method Details

getRealm

public Realm getRealm()

Gets the non-null realm context in which an access token should be produced.

Returns:

the non-null realm context

getClientId

public String getClientId()

Gets the non-null OAuth2 client id.

Returns:

the non-null client id

getClientSecret

public String getClientSecret()

Gets the non-null OAuth2 client secret.

Returns:

the non-null client secret

getScopes

public Set<String> getScopes()

Gets the non-null available set of scopes.

Returns:

the non-null set of scopes

getRequest

public Request getRequest()

Gets the original Request that prompted this request for an access token.

Returns:

the non null request.

getSubject

public String getSubject()

getGrantType

public AccessTokenRequest.GrantType getGrantType()

builder

public static AccessTokenRequest.Builder builder()

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

Returns:

a builder instance