com.broadleafcommerce.cartoperation.service

Class DefaultGuestCartProtectionService

java.lang.Object

com.broadleafcommerce.cartoperation.service.DefaultGuestCartProtectionService

All Implemented Interfaces:

GuestCartProtectionService

public class DefaultGuestCartProtectionService
extends Object
implements GuestCartProtectionService

Default implementation of GuestCartProtectionService that clears typical customer information and utilizes CartProvider for storing guest tokens.

Author:

Nick Crum (ncrum)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INVALID_GUEST_TOKEN_FMT

Constructor Summary

Constructors

Constructor and Description
DefaultGuestCartProtectionService(GuestTokenProvider tokenProvider, GuestTokenGenerator tokenGenerator)

Method Summary

Modifier and Type	Method and Description
void	clearCustomerInformation(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart) Clears customer information from the provided cart.
com.broadleafcommerce.cart.client.domain.GuestToken	createGuestToken(@NonNull String cartId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Creates a new guest token for the cart with the provided ID.
protected GuestTokenGenerator	getTokenGenerator()
protected GuestTokenProvider	getTokenProvider()
protected boolean	isTokenExpired(com.broadleafcommerce.cart.client.domain.GuestToken retrieved)
com.broadleafcommerce.cart.client.domain.GuestToken	validateGuestToken(@NonNull String cartId, @NonNull String guestToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Validates the provided guest token string for the given cart ID.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_GUEST_TOKEN_FMT

protected static final String INVALID_GUEST_TOKEN_FMT

See Also:

Constant Field Values

Constructor Detail

DefaultGuestCartProtectionService

public DefaultGuestCartProtectionService(GuestTokenProvider tokenProvider,
                                         GuestTokenGenerator tokenGenerator)

Method Detail

clearCustomerInformation

public void clearCustomerInformation(@NonNull
                                     @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Description copied from interface: GuestCartProtectionService

Clears customer information from the provided cart. This is typically used to filter out personal information from a guest cart when a guest token is not present, or when generating a new guest token.

Note, this method will not persist any changes to the cart. Instead, CartOperationService.updateCart(Cart, boolean, boolean, boolean, ContextInfo) should be used to save the cart if the changes are meant to be permanent.

Specified by:

clearCustomerInformation in interface GuestCartProtectionService

Parameters:

cart - the cart to clear

createGuestToken

public com.broadleafcommerce.cart.client.domain.GuestToken createGuestToken(@NonNull
                                                                            @NonNull String cartId,
                                                                            @Nullable
                                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: GuestCartProtectionService

Creates a new guest token for the cart with the provided ID. This typically creates or replaces a token within a token store for the given cart ID, and returns the resulting token details.

Specified by:

createGuestToken in interface GuestCartProtectionService

Parameters:

cartId - the cart ID

contextInfo - the context info

Returns:

the token details

validateGuestToken

public com.broadleafcommerce.cart.client.domain.GuestToken validateGuestToken(@NonNull
                                                                              @NonNull String cartId,
                                                                              @NonNull
                                                                              @NonNull String guestToken,
                                                                              @Nullable
                                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: GuestCartProtectionService

Validates the provided guest token string for the given cart ID. This typically retrieves a the token details from a token store using the cart ID, and verifies they match up with the provided token string. If verified, this will return the token details. If not verified, this will throw a GuestTokenValidationException indicating the token failed to validate.

Specified by:

validateGuestToken in interface GuestCartProtectionService

Parameters:

cartId - the cart ID

guestToken - the guest token string

contextInfo - the context info

Returns:

the verified token details

isTokenExpired

protected boolean isTokenExpired(com.broadleafcommerce.cart.client.domain.GuestToken retrieved)

getTokenProvider

protected GuestTokenProvider getTokenProvider()

getTokenGenerator

protected GuestTokenGenerator getTokenGenerator()