Package com.broadleafcommerce.auth.resource.domain

Class SessionTokenClaimKeys

java.lang.Object

com.broadleafcommerce.auth.resource.domain.SessionTokenClaimKeys

public final class SessionTokenClaimKeys
extends Object

Contains constants that are used as keys for token claims for session tokens.

See Also:

• OAuth2SessionToken
• AccessTokenClaimKeys

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SessionTokenClaimKeys.ImpersonationClaims	Though these are used in OAuth2SessionToken, some of these claims are also used in access tokens.
static final class	SessionTokenClaimKeys.RememberMeLoginClaims	Claims used when using 'Remember Me' login.
static final class	SessionTokenClaimKeys.ThirdPartyLoginClaims	Claims used when using 'Third Party Login'.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_ID	The claim storing a String client ID for the current session.
static final String	EXPIRATION_TIME	The claim storing a Date object for the current expiration of the token.
static final String	MAX_EXPIRATION_TIME	The claim storing a Date object for the 'max' expiration of the token
static final String	SESSION_ID	A string value that represents the unique identifier for this session.
static final String	SUBJECT	The claim storing a String user subject for the current session.
static final String	USER_ID	The claim storing a user's ID for the current session.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

USER_ID

public static final String USER_ID

The claim storing a user's ID for the current session.

See Also:

• Constant Field Values

SUBJECT

public static final String SUBJECT

The claim storing a String user subject for the current session.

See Also:

• Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

The claim storing a String client ID for the current session.

See Also:

• Constant Field Values

EXPIRATION_TIME

public static final String EXPIRATION_TIME

The claim storing a Date object for the current expiration of the token.

See Also:

• Constant Field Values

MAX_EXPIRATION_TIME

public static final String MAX_EXPIRATION_TIME

The claim storing a Date object for the 'max' expiration of the token

See Also:

• Constant Field Values

SESSION_ID

public static final String SESSION_ID

A string value that represents the unique identifier for this session. Upon login, a new, unique value is generated for this claim. Across subsequent refreshes of the session token in OAuth2SessionAuthenticationFilter, the same session ID is carried forward to ensure consistent identification of a session lineage.

Since:

AuthenticationServices 3.0.0, Release Train 3.0.0

See Also:

• Constant Field Values