com.broadleafcommerce.cartoperation.service.checkout

Class DefaultCheckoutService

java.lang.Object

com.broadleafcommerce.cartoperation.service.checkout.DefaultCheckoutService

All Implemented Interfaces:

CheckoutService

public class DefaultCheckoutService
extends Object
implements CheckoutService

Default implementation of the CheckoutService that is responsible for processing checkout requests

Author:

Chad Harchar (charchar), Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description
DefaultCheckoutService(CheckoutWorkflow checkoutWorkflow, CartProvider cartProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory, com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer checkoutCompletionProducer, CartStatusValidationHelper cartStatusValidationHelper, ExternalCartProperties externalCartProperties)

Method Summary

Modifier and Type	Method and Description
protected void	addCartLinks(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String	createOrderNumber(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart) Creates a new order number for a submitted cart.
protected com.broadleafcommerce.cart.client.domain.Cart	finalizeCart(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Following a successful checkout, this method is responsible for recording the finalized state of the cart.
protected com.broadleafcommerce.cart.client.domain.CartLink	getCartItemLink(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CartProvider	getCartProvider()
protected CartStatusValidationHelper	getCartStatusValidationHelper()
protected com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer	getCheckoutCompletionProducer()
protected CheckoutWorkflow	getCheckoutWorkflow()
protected ExternalCartProperties	getExternalCartProperties()
protected com.broadleafcommerce.cart.client.domain.CartLink	getFulfillmentGroupLink(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected com.broadleafcommerce.cart.client.domain.Cart	prepareCartForCheckout(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Updates the cart with the checkout request ID and status for checkout
CheckoutResponse	processCheckout(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Process checkout against the provided cart
CheckoutResponse	processCheckout(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, @NonNull Map<String,String> securityCodes, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Process checkout against the provided cart
protected void	sendCheckoutCompletionMessage(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Send a message to notify external services (and internal listeners) of the completed checkout so that they can react accordingly.
protected boolean	shouldResetCartStatus(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String originalCartStatus, @NonNull CheckoutWorkflowException e) Determines whether or not the cart's status should be reset after encountering an unexpected exception during checkout.
protected com.broadleafcommerce.cart.client.domain.Cart	updateCartStatus(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String cartStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	validateCheckoutRequest(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId) Validates the cart for checkout
protected void	validateRequestId(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId) Validates that the current requestId is not already associated to the cart

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCheckoutService

public DefaultCheckoutService(CheckoutWorkflow checkoutWorkflow,
                              CartProvider cartProvider,
                              com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                              com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer checkoutCompletionProducer,
                              CartStatusValidationHelper cartStatusValidationHelper,
                              ExternalCartProperties externalCartProperties)

Method Detail

processCheckout

public CheckoutResponse processCheckout(@NonNull
                                        @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                        @NonNull
                                        @NonNull String requestId,
                                        @Nullable
                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CheckoutService

Process checkout against the provided cart

Specified by:

processCheckout in interface CheckoutService

Parameters:

cart - The cart with which to process checkout.

requestId - The id representing this request to checkout

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart after it has gone through checkout.

processCheckout

public CheckoutResponse processCheckout(@NonNull
                                        @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                        @NonNull
                                        @NonNull String requestId,
                                        @NonNull
                                        @NonNull Map<String,String> securityCodes,
                                        @Nullable
                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CheckoutService

Process checkout against the provided cart

Specified by:

processCheckout in interface CheckoutService

Parameters:

cart - The cart with which to process checkout.

requestId - The id representing this request to checkout

securityCodes - The map of card security codes keyed by payment id for processing saved payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart after it has gone through checkout.

validateCheckoutRequest

protected void validateCheckoutRequest(@NonNull
                                       @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                       @NonNull
                                       @NonNull String requestId)

Validates the cart for checkout

Parameters:

cart - The cart to validate

requestId - The checkout request id

validateRequestId

protected void validateRequestId(@NonNull
                                 @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                 @NonNull
                                 @NonNull String requestId)

Validates that the current requestId is not already associated to the cart

Parameters:

cart - The cart to validate

requestId - The checkout request id

Throws:

CheckoutWorkflowException - Thrown if the current requestId is already present in the cart's past checkout submissions

prepareCartForCheckout

protected com.broadleafcommerce.cart.client.domain.Cart prepareCartForCheckout(@NonNull
                                                                               @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                               @NonNull
                                                                               @NonNull String requestId,
                                                                               @Nullable
                                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Updates the cart with the checkout request ID and status for checkout

Parameters:

cart - The cart to be updated

requestId - The checkout request id

contextInfo - Context information around sandbox and multitenant state

updateCartStatus

protected com.broadleafcommerce.cart.client.domain.Cart updateCartStatus(@NonNull
                                                                         @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                         @NonNull
                                                                         @NonNull String cartStatus,
                                                                         @Nullable
                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

shouldResetCartStatus

protected boolean shouldResetCartStatus(@NonNull
                                        @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                        @NonNull
                                        @NonNull String originalCartStatus,
                                        @NonNull
                                        @NonNull CheckoutWorkflowException e)

Determines whether or not the cart's status should be reset after encountering an unexpected exception during checkout.

Parameters:

cart - The cart related to the checkout request

originalCartStatus - The status of the cart prior to attempting checkout

e - The CheckoutWorkflowException that caused the checkout to fail

Returns:

finalizeCart

protected com.broadleafcommerce.cart.client.domain.Cart finalizeCart(@NonNull
                                                                     @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                     @Nullable
                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Following a successful checkout, this method is responsible for recording the finalized state of the cart.

Parameters:

cart - The cart that has completed checkout, but needs to be marked as finalized

Returns:

The finalized cart

createOrderNumber

protected String createOrderNumber(@NonNull
                                   @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Creates a new order number for a submitted cart.

Returns:

New order number for submitted cart.

sendCheckoutCompletionMessage

protected void sendCheckoutCompletionMessage(@NonNull
                                             @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                             @NonNull
                                             @NonNull String requestId,
                                             @Nullable
                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Send a message to notify external services (and internal listeners) of the completed checkout so that they can react accordingly.

Parameters:

cart - The cart that has completed checkout. This should be the primary content of the out-going message.

requestId - The checkout request id

contextInfo - Context information around sandbox and multitenant state.

addCartLinks

protected void addCartLinks(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart,
                            @Nullable
                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getFulfillmentGroupLink

protected com.broadleafcommerce.cart.client.domain.CartLink getFulfillmentGroupLink(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart,
                                                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getCartItemLink

protected com.broadleafcommerce.cart.client.domain.CartLink getCartItemLink(com.broadleafcommerce.cart.client.domain.CheckoutCart checkoutCart,
                                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getCheckoutWorkflow

protected CheckoutWorkflow getCheckoutWorkflow()

getCartProvider

protected CartProvider getCartProvider()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getCheckoutCompletionProducer

protected com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer getCheckoutCompletionProducer()

getCartStatusValidationHelper

protected CartStatusValidationHelper getCartStatusValidationHelper()

getExternalCartProperties

protected ExternalCartProperties getExternalCartProperties()