Package com.broadleafcommerce.auth.user.session.token.enhancer

Class CurrentUserCacheAccessTokenEnhancer

java.lang.Object

com.broadleafcommerce.auth.user.session.token.enhancer.CurrentUserCacheAccessTokenEnhancer

All Implemented Interfaces:

JwtAccessTokenEnhancer, org.springframework.core.Ordered

public class CurrentUserCacheAccessTokenEnhancer
extends Object
implements JwtAccessTokenEnhancer

Many access token enhancers need to obtain information from the currently authenticated User.

To avoid having each of those enhancers read from the database multiple times, this early-ordered component pre-fetches the User once and caches it in JwtTokenEnhancerContext.getAdditionalContext(). Subsequent enhancers (typically extensions of AbstractUserAccessTokenEnhancer) can then obtain the pre-fetched user from there to get any information they need.

This component does not actually add any claims to the access token.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_USER	The key used by this component to store a value in JwtTokenEnhancerContext.getAdditionalContext()

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
CurrentUserCacheAccessTokenEnhancer(TokenEnhancerUtility tokenEnhancerUtility, UserService<User> userService)

Method Summary

Modifier and Type	Method	Description
void	enhance(JwtTokenEnhancerContext context)	Evaluate the authentication and add claims as necessary.
int	getOrder()
protected Optional<OAuth2SessionToken>	getSessionToken(org.springframework.security.core.Authentication userPrincipal)	Get the session token from the authentication token.
protected TokenEnhancerUtility	getTokenEnhancerUtility()
protected String	getUserIdFromSession(org.springframework.security.core.Authentication userPrincipal)	Read the User ID from the session token.
protected UserService<User>	getUserService()
protected User	readUser(org.springframework.security.core.Authentication userPrincipal)

Methods inherited from class java.lang.Object

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

Field Details

CURRENT_USER

public static final String CURRENT_USER

The key used by this component to store a value in JwtTokenEnhancerContext.getAdditionalContext()

See Also:

• Constant Field Values

Constructor Details

CurrentUserCacheAccessTokenEnhancer

public CurrentUserCacheAccessTokenEnhancer(TokenEnhancerUtility tokenEnhancerUtility,
 UserService<User> userService)

Method Details

enhance

public void enhance(JwtTokenEnhancerContext context)

Description copied from interface: JwtAccessTokenEnhancer

Evaluate the authentication and add claims as necessary. A JwtTokenEnhancerContext contains User and client authentication tokens, authorization tokens, and access token claims.

Specified by:

enhance in interface JwtAccessTokenEnhancer

Parameters:

context - The JwtTokenEnhancerContext to evaluate.

readUser

protected User readUser(org.springframework.security.core.Authentication userPrincipal)

getUserIdFromSession

@Nullable
protected String getUserIdFromSession(org.springframework.security.core.Authentication userPrincipal)

Read the User ID from the session token.

Parameters:

userPrincipal - The Authentication representing the User.

Returns:

The User ID from the session token, or null if it is not available.

getSessionToken

protected Optional<OAuth2SessionToken> getSessionToken(org.springframework.security.core.Authentication userPrincipal)

Get the session token from the authentication token.

Parameters:

userPrincipal - The OAuth2SessionAuthenticationToken of the User.

Returns:

An Optional with the OAuth2SessionToken if available, or empty.

getOrder

public int getOrder()

Specified by:

getOrder in interface JwtAccessTokenEnhancer

Specified by:

getOrder in interface org.springframework.core.Ordered

getTokenEnhancerUtility

protected TokenEnhancerUtility getTokenEnhancerUtility()

getUserService

protected UserService<User> getUserService()