Package org.forgerock.oauth2.core

Class StatefulRefreshToken

java.lang.Object

org.forgerock.json.JsonValue

org.forgerock.oauth2.core.StatefulToken

org.forgerock.oauth2.core.StatefulRefreshToken

All Implemented Interfaces:

Cloneable, Iterable<org.forgerock.json.JsonValue>, IntrospectableToken, RefreshToken, Token

public class StatefulRefreshToken
extends StatefulToken
implements RefreshToken

Models a OAuth2 Refresh Token.

Since:

12.0.0

Constructor Summary

Constructors

Constructor	Description
StatefulRefreshToken(String id, String resourceOwnerId, String clientId, String redirectUri, Set<String> scope, long expiryTime, String tokenType, String tokenName, String grantType, String realm, String authModules, String acr, String auditId, String authGrantId)	Constructs a new RefreshToken.
StatefulRefreshToken(String id, String resourceOwnerId, String clientId, String redirectUri, Set<String> scope, long expiryTime, String tokenType, String tokenName, String grantType, String realm, String authModules, String acr, String auditId, String authGrantId, long authTime)	Constructs a new RefreshToken.
StatefulRefreshToken(org.forgerock.json.JsonValue token)	Constructs a new RefreshToken backed with the data in the specified JsonValue.

Method Summary

Modifier and Type	Method	Description
protected long	defaultExpireTime()
String	getAuditTrackingId()	Gets the audit id.
AuditConstants.TrackingIdKey	getAuditTrackingIdKey()	Get the audit tracking ID key for this token.
String	getAuthenticationContextClassReference()	Get the Authentication Context Class Reference (acr).
String	getAuthGrantId()	Gets the token's Auth Grant id.
String	getAuthModules()	Gets the auth modules used for authentication.
long	getAuthTimeSeconds()	Gets the end user's authentication time in seconds.
String	getClaims()	Gets the requested claims.
long	getExpiryTime()	Gets the token's expiry time.
String	getRealm()	Gets the realm.
String	getRedirectUri()	Gets the client's redirect uri.
protected String	getResourceString(String s)	Gets the display String for the given String.
Set<String>	getScope()	Gets the scope.
protected Long	getTimeLeft()
Map<String,Object>	getTokenInfo()	Gets the token's information.
boolean	isExpired()	Determines if the Refresh Token has expired.
protected void	setAuditTrackingId(String auditId)	Sets the audit id.
protected void	setAuthenticationContextClassReference(String acr)	Sets the authentication context class reference (acr).
protected void	setAuthModules(String authModules)	Sets the auth modules used for authentication.
protected void	setAuthTime(long authTime)	Sets the end user's original authentication time in seconds since epoch.
void	setClaims(String claims)	Sets the requested claims.
protected void	setExpiryTime(long expiryTime)	Sets the expiry time.
protected void	setScope(Set<String> scope)	Sets the scope.
Map<String,Object>	toMap()	Converts the token into a Map of its key data.
String	toString()

Methods inherited from class org.forgerock.oauth2.core.StatefulToken

getClientId, getResourceOwnerId, getSetProperty, getStringProperty, getTokenId, getTokenName, getTokenType, setAuthGrantId, setClientId, setGrantType, setId, setRedirectUri, setResourceOwnerId, setStringProperty, setTokenName, setTokenType, toJsonValue

Methods inherited from class org.forgerock.json.JsonValue

add, add, add, add, addPermissive, array, as, asBigDecimal, asBoolean, asCollection, asCollection, asDouble, asEnum, asInteger, asList, asList, asLong, asMap, asMap, asMapOfList, asNumber, asSet, asSet, asString, asURI, clear, clone, contains, copy, defaultTo, diff, expect, field, fieldIfNotNull, get, get, get, getObject, getPointer, isBoolean, isCollection, isDefined, isEqualTo, isList, isMap, isNotNull, isNull, isNumber, isSet, isString, iterator, json, keys, object, object, patch, put, put, put, putPermissive, remove, remove, remove, required, set, setObject, size, toIndex

Methods inherited from class java.lang.Object

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

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

getClientId, getResourceOwnerId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

getTokenId, getTokenType

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

getTokenName, toJsonValue

Constructor Detail

StatefulRefreshToken

public StatefulRefreshToken(org.forgerock.json.JsonValue token)
                     throws InvalidGrantException

Constructs a new RefreshToken backed with the data in the specified JsonValue.

Parameters:

token - The JsonValue of the token.

Throws:

InvalidGrantException - If the given token is not a Refresh Token.

StatefulRefreshToken

public StatefulRefreshToken(String id,
                            String resourceOwnerId,
                            String clientId,
                            String redirectUri,
                            Set<String> scope,
                            long expiryTime,
                            String tokenType,
                            String tokenName,
                            String grantType,
                            String realm,
                            String authModules,
                            String acr,
                            String auditId,
                            String authGrantId)

Constructs a new RefreshToken.

Parameters:

id - The token id.

resourceOwnerId - The resource owner's id.

clientId - The client's id.

redirectUri - The redirect uri.

scope - The scope.

expiryTime - The expiry time.

tokenType - The token type.

tokenName - The token name.

grantType - The grant type.

realm - The realm.

authModules - The pipe-separated list of auth modules.

acr - The authentication context.

auditId - The audit id, used for tracking tokens throughout the audit logs.

authGrantId - The authorization grant id.

StatefulRefreshToken

public StatefulRefreshToken(String id,
                            String resourceOwnerId,
                            String clientId,
                            String redirectUri,
                            Set<String> scope,
                            long expiryTime,
                            String tokenType,
                            String tokenName,
                            String grantType,
                            String realm,
                            String authModules,
                            String acr,
                            String auditId,
                            String authGrantId,
                            long authTime)

Constructs a new RefreshToken.

Parameters:

id - The token id.

resourceOwnerId - The resource owner's id.

clientId - The client's id.

redirectUri - The redirect uri.

scope - The scope.

expiryTime - The expiry time.

tokenType - The token type.

tokenName - The token name.

grantType - The grant type.

realm - The realm.

authModules - The pipe-separated list of auth modules.

acr - The authentication context.

auditId - The audit id, used for tracking tokens throughout the audit logs.

authGrantId - The authorization grant id.

authTime - The end user's original auth time in seconds.

Method Detail

setClaims

public void setClaims(String claims)

Sets the requested claims.

Parameters:

claims - Requested claims

getClaims

public String getClaims()

Gets the requested claims.

Specified by:

getClaims in interface RefreshToken

Overrides:

getClaims in class StatefulToken

Returns:

The claims.

setScope

protected void setScope(Set<String> scope)

Sets the scope.

Overrides:

setScope in class StatefulToken

Parameters:

scope - The scope.

setExpiryTime

protected void setExpiryTime(long expiryTime)

Sets the expiry time.

Overrides:

setExpiryTime in class StatefulToken

Parameters:

expiryTime - The expiry time.

getRealm

public String getRealm()

Gets the realm.

Specified by:

getRealm in interface IntrospectableToken

Overrides:

getRealm in class StatefulToken

Returns:

The token's realm.

getResourceString

protected String getResourceString(String s)

Gets the display String for the given String.

Overrides:

getResourceString in class StatefulToken

Parameters:

s - The String.

Returns:

The display String.

getScope

public Set<String> getScope()

Gets the scope.

Specified by:

getScope in interface IntrospectableToken

Overrides:

getScope in class StatefulToken

Returns:

The scope.

getExpiryTime

public long getExpiryTime()

Gets the token's expiry time.

Specified by:

getExpiryTime in interface IntrospectableToken

Overrides:

getExpiryTime in class StatefulToken

Returns:

The token's expiry time.

setAuthModules

protected void setAuthModules(String authModules)

Sets the auth modules used for authentication.

Parameters:

authModules - A pipe-delimited string of auth module names.

setAuthenticationContextClassReference

protected void setAuthenticationContextClassReference(String acr)

Sets the authentication context class reference (acr).

Parameters:

acr - The acr.

getRedirectUri

public String getRedirectUri()

Gets the client's redirect uri.

Specified by:

getRedirectUri in interface RefreshToken

Returns:

The client's redirect uri.

getAuthenticationContextClassReference

public String getAuthenticationContextClassReference()

Get the Authentication Context Class Reference (acr).

Specified by:

getAuthenticationContextClassReference in interface RefreshToken

Returns:

The acr string matched, if any.

isExpired

public boolean isExpired()

Determines if the Refresh Token has expired.

Specified by:

isExpired in interface IntrospectableToken

Overrides:

isExpired in class StatefulToken

Returns:

true if current time is greater than the expiry time.

defaultExpireTime

protected long defaultExpireTime()

Specified by:

defaultExpireTime in class StatefulToken

getAuthModules

public String getAuthModules()

Gets the auth modules used for authentication.

Specified by:

getAuthModules in interface RefreshToken

Returns:

A pipe-delimited string of auth module names.

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 RefreshToken

Specified by:

toMap in interface Token

Returns:

A Map of the token's key data.

getTokenInfo

public Map<String,Object> getTokenInfo()

Description copied from interface: Token

Gets the token's information.

Specified by:

getTokenInfo in interface Token

Returns:

A Map of the token's information.

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.

getAuthGrantId

public String getAuthGrantId()

Description copied from interface: RefreshToken

Gets the token's Auth Grant id.

Specified by:

getAuthGrantId in interface RefreshToken

Returns:

The token's Auth Grant id.

getTimeLeft

protected Long getTimeLeft()

Overrides:

getTimeLeft in class StatefulToken

setAuditTrackingId

protected void setAuditTrackingId(String auditId)

Sets the audit id.

Parameters:

auditId - The audit id.

getAuditTrackingId

public String getAuditTrackingId()

Gets the audit id.

Specified by:

getAuditTrackingId in interface RefreshToken

Specified by:

getAuditTrackingId in interface Token

Overrides:

getAuditTrackingId in class StatefulToken

Returns:

The audit id.

setAuthTime

protected void setAuthTime(long authTime)

Sets the end user's original authentication time in seconds since epoch.

Overrides:

setAuthTime in class StatefulToken

Parameters:

authTime - The authentication time.

getAuthTimeSeconds

public long getAuthTimeSeconds()

Gets the end user's authentication time in seconds.

Specified by:

getAuthTimeSeconds in interface IntrospectableToken

Overrides:

getAuthTimeSeconds in class StatefulToken

Returns:

The authentication time.

toString

public String toString()

Overrides:

toString in class org.forgerock.json.JsonValue