org.forgerock.oauth2.core

Interface Token

All Known Subinterfaces:

AccessToken, IntrospectableToken, RefreshToken

All Known Implementing Classes:

AuthorizationCode, DeviceCode, OpenIdConnectToken, StatefulAccessToken, StatefulRefreshToken, StatelessAccessToken, StatelessRefreshToken

public interface Token

Models a OAuth2 token.

Since:

12.0.0

Method Summary

Modifier and Type	Method and Description
String	getAuditTrackingId() Get the audit tracking ID for this token.
AuditConstants.TrackingIdKey	getAuditTrackingIdKey() Get the audit tracking ID key for this token.
String	getTokenId() Gets the token's identifier.
Map<String,Object>	getTokenInfo() Gets the token's information.
String	getTokenName() Gets the token's name.
org.forgerock.json.JsonValue	toJsonValue() Gets the JsonValue representation of the token.
Map<String,Object>	toMap() Converts the token into a Map of its key data.

Method Detail

getTokenId

String getTokenId()
           throws ServerException

Gets the token's identifier.

Returns:

The token's id.

Throws:

ServerException - If any internal server error occurs.

getTokenName

String getTokenName()

Gets the token's name.

Returns:

The token's name.

toMap

Map<String,Object> toMap()
                  throws ServerException

Converts the token into a Map of its key data.

Returns:

A Map of the token's key data.

Throws:

ServerException - If any internal server error occurs.

getTokenInfo

Map<String,Object> getTokenInfo()

Gets the token's information.

Returns:

A Map of the token's information.

toJsonValue

org.forgerock.json.JsonValue toJsonValue()

Gets the JsonValue representation of the token.

Returns:

The JsonValue representation of the token.

getAuditTrackingId

String getAuditTrackingId()

Get the audit tracking ID for this token.

Returns:

The tracking ID.

getAuditTrackingIdKey

AuditConstants.TrackingIdKey getAuditTrackingIdKey()

Get the audit tracking ID key for this token.

Returns:

The tracking ID key.