org.forgerock.openam.oauth2

Class StatelessAccessToken

java.lang.Object

org.forgerock.openam.oauth2.StatelessToken

org.forgerock.openam.oauth2.StatelessAccessToken

All Implemented Interfaces:

AccessToken, IntrospectableToken, Token

public final class StatelessAccessToken
extends StatelessToken
implements AccessToken

Models a stateless OpenAM OAuth2 access token.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	extraData

Fields inherited from class org.forgerock.openam.oauth2.StatelessToken

jwt

Constructor Summary

Constructors

Constructor and Description
StatelessAccessToken(org.forgerock.json.jose.jwt.Jwt jwt, String jwtString) Constructs a new StatelessAccessToken backed with the specified Jwt.

Method Summary

Modifier and Type	Method and Description
void	addExtraData(String key, String value) Adds additional data to the Access Token.
AuditConstants.TrackingIdKey	getAuditTrackingIdKey() Get the audit tracking ID key for this token.
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.
protected String	getResourceString(String s)
String	getSessionId() Gets the token's associated session id.
String	getTokenName() Gets the token's name.
Map<String,Object>	toMap() Converts the token into a Map of its key data.

Methods inherited from class org.forgerock.openam.oauth2.StatelessToken

getAuditTrackingId, getAuthGrantId, getAuthTimeSeconds, getClaims, getClientId, getExpiryTime, getJwtId, getRealm, getResourceOwnerId, getScope, getTimeLeft, getTokenId, getTokenInfo, getTokenType, isExpired, toJsonValue, toString

Methods inherited from class java.lang.Object

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

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

getAuditTrackingId, getClaims, getTokenId, getTokenType

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

getTokenInfo, toJsonValue

Field Detail

extraData

protected Map<String,Object> extraData

Constructor Detail

StatelessAccessToken

public StatelessAccessToken(org.forgerock.json.jose.jwt.Jwt jwt,
                            String jwtString)

Constructs a new StatelessAccessToken backed with the specified Jwt.

Parameters:

jwt - The stateless token.

jwtString - The JWT string.

Method Detail

getTokenName

public String getTokenName()

Description copied from interface: Token

Gets the token's name.

Specified by:

getTokenName in interface Token

Overrides:

getTokenName in class StatelessToken

Returns:

The token's name.

getNonce

public String getNonce()

Description copied from interface: AccessToken

Gets the token's nonce.

Specified by:

getNonce in interface AccessToken

Returns:

The token's nonce.

getSessionId

public String getSessionId()

Description copied from interface: AccessToken

Gets the token's associated session id.

Specified by:

getSessionId in interface AccessToken

Returns:

The token's session id.

getGrantType

public String getGrantType()

Description copied from interface: AccessToken

Gets the token's grant type.

Specified by:

getGrantType in interface AccessToken

Returns:

The token's grant type.

getResourceString

protected String getResourceString(String s)

getConfirmationKey

public org.forgerock.json.JsonValue getConfirmationKey()

Description copied from interface: AccessToken

Get's the tokens confirmation claim.

Specified by:

getConfirmationKey in interface AccessToken

Returns:

the JSON confirmation key

toMap

public Map<String,Object> toMap()

Description copied from interface: Token

Converts the token into a Map of its key data.

Specified by:

toMap in interface AccessToken

Specified by:

toMap in interface Token

Returns:

A Map of the token's key data.

getAuditTrackingIdKey

public AuditConstants.TrackingIdKey getAuditTrackingIdKey()

Description copied from interface: Token

Get the audit tracking ID key for this token.

Specified by:

getAuditTrackingIdKey in interface Token

Returns:

The tracking ID key.

addExtraData

public void addExtraData(String key,
                         String value)

Adds additional data to the Access Token.

If the value is null then this method will ensure that the key is not present in the map.

Specified by:

addExtraData in interface AccessToken

Parameters:

key - The key.

value - The value.