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

Class AbstractUserAccessTokenEnhancer

java.lang.Object

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

All Implemented Interfaces:

JwtAccessTokenEnhancer, org.springframework.core.Ordered

Direct Known Subclasses:

AccountIdAccessTokenEnhancer, CustomerContextAccessTokenEnhancer, CustomerSegmentsAccessTokenEnhancer, TenantPropertiesAccessTokenEnhancer, UserAccessTokenEnhancer, UserRestrictionAccessTokenEnhancer

public abstract class AbstractUserAccessTokenEnhancer
extends Object
implements JwtAccessTokenEnhancer

Implementation of JwtAccessTokenEnhancer with commonly useful functionality for accessing User data. TokenEnhancer implementations that require access to the User should extend this class and retrieve the user via the getUser(com.broadleafcommerce.auth.user.session.token.enhancer.JwtTokenEnhancerContext) method.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Optional<OAuth2SessionToken>	getSessionToken(org.springframework.security.core.Authentication userPrincipal)	Get the session token from the authentication token.
protected TokenEnhancerUtility	getTokenEnhancerUtility()
protected User	getUser(JwtTokenEnhancerContext context)	Retrieve the current authenticated User.
protected UserService<User>	getUserService()
protected boolean	isAnonymousCsrImpersonation(JwtTokenEnhancerContext context)	Check whether the current authentication is a CSR impersonation of an anonymous user.
protected boolean	isClientOnly(JwtTokenEnhancerContext context)	Whether the authorization in the context represents a client-only authorization.
protected boolean	shouldEnhance(JwtTokenEnhancerContext context)	Whether the token should be enhanced.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.auth.user.session.token.enhancer.JwtAccessTokenEnhancer

enhance, getOrder

Constructor Details

AbstractUserAccessTokenEnhancer

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

Method Details

getUser

protected User getUser(JwtTokenEnhancerContext context)

Retrieve the current authenticated User. This method assumes that the user is logged in and exists.

Parameters:

context - The JwtTokenEnhancerContext containing relevant information

Returns:

The currently authenticated user.

See Also:

• CurrentUserCacheAccessTokenEnhancer

isAnonymousCsrImpersonation

protected boolean isAnonymousCsrImpersonation(JwtTokenEnhancerContext context)

Check whether the current authentication is a CSR impersonation of an anonymous user.

Parameters:

context - The JwtTokenEnhancerContext object passed to JwtAccessTokenEnhancer.enhance(JwtTokenEnhancerContext).

Returns:

True if the current authentication is a CSR impersonation of an anonymous user.

shouldEnhance

protected boolean shouldEnhance(JwtTokenEnhancerContext context)

Whether the token should be enhanced.

Parameters:

context - The JwtTokenEnhancerContext object passed to JwtAccessTokenEnhancer.enhance(JwtTokenEnhancerContext).

Returns:

True if this JwtAccessTokenEnhancer should execute for the given JwtTokenEnhancerContext.

isClientOnly

protected boolean isClientOnly(JwtTokenEnhancerContext context)

Whether the authorization in the context represents a client-only authorization. That is, an authorization without a User.

Parameters:

context - The JwtTokenEnhancerContext object passed to JwtAccessTokenEnhancer.enhance(JwtTokenEnhancerContext).

Returns:

True if this context holds a client-only authorization.

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.

getUserService

protected UserService<User> getUserService()

getTokenEnhancerUtility

protected TokenEnhancerUtility getTokenEnhancerUtility()