Package com.broadleafcommerce.cartoperation.web.service

Class DefaultCartCookieIssuer

java.lang.Object

com.broadleafcommerce.cartoperation.web.service.DefaultCartCookieIssuer

All Implemented Interfaces:

CartCookieIssuer

public class DefaultCartCookieIssuer
extends Object
implements CartCookieIssuer

Author:

Chris Kittrell (ckittrell)

See Also:

CartCookieIssuer

Constructor Summary

Constructors

Constructor	Description
DefaultCartCookieIssuer(CartCookieProperties cookieProps)

Method Summary

Modifier and Type	Method	Description
protected void	addCartCookieClaims(com.nimbusds.jwt.JWTClaimsSet.Builder jwtBuilder, com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
javax.servlet.http.Cookie	buildCartCookie(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Build a cookie to hold a reference to a cart.
javax.servlet.http.Cookie	buildCartExpirationCookie(String applicationId)	Build a cookie meant to remove the cart cookie for the provided application.
org.springframework.http.ResponseCookie	buildCartResponseCookie(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Build a cookie to hold a reference to a cart.
boolean	checkContextMatches(Map<String,Object> cartCookieClaims, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Check if the provided cookie claims match the context.
protected String	getApplicationId(com.broadleafcommerce.cart.client.domain.Cart cart)
String	getCartCookieName(String applicationId)	Name of the cart cookie.
protected Duration	getCartTtl()
protected boolean	isApplicationIdIncludedInCookieName()
Optional<String>	resolveCartId(Map<String,Object> cartCookieClaims)	Resolve the cart id from the provided cookie claims.
protected <T> Optional<T>	resolveClaim(Map<String,Object> cartCookieClaims, String name, Class<T> clazz)
protected Optional<com.nimbusds.jwt.SignedJWT>	verify(javax.servlet.http.Cookie cartCookie)
Map<String,Object>	verifyAndGetClaims(@NonNull javax.servlet.http.Cookie cartCookie)	Verify the provided cart cookie and get its claims.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCartCookieIssuer

public DefaultCartCookieIssuer(CartCookieProperties cookieProps)

Method Detail

buildCartCookie

public javax.servlet.http.Cookie buildCartCookie(@NonNull
                                                 @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                 @Nullable
                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CartCookieIssuer

Build a cookie to hold a reference to a cart. If the cart is for a logged in user, no cart ID claim will be part of the cookie.

Specified by:

buildCartCookie in interface CartCookieIssuer

Parameters:

cart - The cart for which to build a cookie.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart cookie to be added to the response.

buildCartResponseCookie

public org.springframework.http.ResponseCookie buildCartResponseCookie(@NonNull
                                                                       @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                       @Nullable
                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CartCookieIssuer

Build a cookie to hold a reference to a cart. If the cart is for a logged in user, no cart ID claim will be part of the cookie.

Specified by:

buildCartResponseCookie in interface CartCookieIssuer

Parameters:

cart - The cart for which to build a cookie.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart cookie to be added to the response.

addCartCookieClaims

protected void addCartCookieClaims(com.nimbusds.jwt.JWTClaimsSet.Builder jwtBuilder,
                                   com.broadleafcommerce.cart.client.domain.Cart cart,
                                   @Nullable
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getApplicationId

protected String getApplicationId(com.broadleafcommerce.cart.client.domain.Cart cart)

buildCartExpirationCookie

public javax.servlet.http.Cookie buildCartExpirationCookie(String applicationId)

Description copied from interface: CartCookieIssuer

Build a cookie meant to remove the cart cookie for the provided application.

Specified by:

buildCartExpirationCookie in interface CartCookieIssuer

Parameters:

applicationId - Application id used to identify which cart cookie to remove.

Returns:

An immediately expiring cookie to be added to the response.

verifyAndGetClaims

public Map<String,Object> verifyAndGetClaims(@NonNull
                                                   @NonNull javax.servlet.http.Cookie cartCookie)

Description copied from interface: CartCookieIssuer

Verify the provided cart cookie and get its claims.

Specified by:

verifyAndGetClaims in interface CartCookieIssuer

Parameters:

cartCookie - The cookie to use for retrieving the claims

Returns:

The claims on the cart cookie

resolveCartId

public Optional<String> resolveCartId(Map<String,Object> cartCookieClaims)

Description copied from interface: CartCookieIssuer

Resolve the cart id from the provided cookie claims. Expect an empty response for registered user cart cookies.

Specified by:

resolveCartId in interface CartCookieIssuer

Parameters:

cartCookieClaims - The cookie claims to use for retrieving the cart id.

Returns:

Optional cart id for the provided cookie claims.

resolveClaim

protected <T> Optional<T> resolveClaim(Map<String,Object> cartCookieClaims,
                                       String name,
                                       Class<T> clazz)

verify

protected Optional<com.nimbusds.jwt.SignedJWT> verify(javax.servlet.http.Cookie cartCookie)
                                               throws ParseException,
                                                      com.nimbusds.jose.JOSEException

Throws:

ParseException

com.nimbusds.jose.JOSEException

getCartCookieName

public String getCartCookieName(@Nullable
                                String applicationId)

Description copied from interface: CartCookieIssuer

Name of the cart cookie.

Specified by:

getCartCookieName in interface CartCookieIssuer

Parameters:

applicationId - Application id that may be appended to the cookie name.

Returns:

The name of the cart cookie.

checkContextMatches

public boolean checkContextMatches(Map<String,Object> cartCookieClaims,
                                   @Nullable
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CartCookieIssuer

Check if the provided cookie claims match the context.

Specified by:

checkContextMatches in interface CartCookieIssuer

Parameters:

cartCookieClaims - The cookie claims to use for retrieving the cart id.

contextInfo - Context information around sandbox and multitenant state.

Returns:

Whether the provided cookie claims matches the context

isApplicationIdIncludedInCookieName

protected boolean isApplicationIdIncludedInCookieName()

getCartTtl

protected Duration getCartTtl()