org.forgerock.oauth2.core

Interface AccessToken

All Superinterfaces:

IntrospectableToken, Token

All Known Implementing Classes:

StatefulAccessToken, StatelessAccessToken

public interface AccessToken
extends IntrospectableToken

Models an OAuth2 access token.

Method Summary

Modifier and Type	Method and Description
void	addExtraData(String key, String value) Stores additional data inside the token.
String	getAuditTrackingId() Gets the token's audit tracking id.
String	getClaims() Gets the token's claims.
org.forgerock.json.JsonValue	getConfirmationKey() Get's the tokens confirmation claim.
String	getGrantType() Gets the token's grant type.
String	getNonce() Gets the token's nonce.
String	getSessionId() Gets the token's associated session id.
String	getTokenId() Gets the token's identifier.
String	getTokenType() Gets the token's type.
Map<String,Object>	toMap() Converts the token into a Map of its key data.

Methods inherited from interface org.forgerock.oauth2.core.IntrospectableToken

getAuthTimeSeconds, getClientId, getExpiryTime, getRealm, getResourceOwnerId, getScope, isExpired

Methods inherited from interface org.forgerock.oauth2.core.Token

getAuditTrackingIdKey, getTokenInfo, getTokenName, toJsonValue

Method Detail

getNonce

String getNonce()

Gets the token's nonce.

Returns:

The token's nonce.

getSessionId

String getSessionId()

Gets the token's associated session id.

Returns:

The token's session id.

getTokenId

String getTokenId()

Description copied from interface: Token

Gets the token's identifier.

Specified by:

getTokenId in interface Token

Returns:

The token's id.

getClaims

String getClaims()

Gets the token's claims.

Returns:

The token's claims.

getTokenType

String getTokenType()

Gets the token's type.

Returns:

The token's type.

getGrantType

String getGrantType()

Gets the token's grant type.

Returns:

The token's grant type.

getConfirmationKey

org.forgerock.json.JsonValue getConfirmationKey()

Get's the tokens confirmation claim.

Returns:

the JSON confirmation key

toMap

Map<String,Object> toMap()

Description copied from interface: Token

Converts the token into a Map of its key data.

Specified by:

toMap in interface Token

Returns:

A Map of the token's key data.

addExtraData

void addExtraData(String key,
                  String value)

Stores additional data inside the token.

Parameters:

key - The key.

value - The value.

getAuditTrackingId

String getAuditTrackingId()

Gets the token's audit tracking id.

Specified by:

getAuditTrackingId in interface Token

Returns:

The token's audit tracking id.