Package org.broadleafcommerce.core.web.controller.cart

Class BroadleafCartController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.core.web.controller.cart.AbstractCartController

org.broadleafcommerce.core.web.controller.cart.BroadleafCartController

public class BroadleafCartController
extends AbstractCartController

In charge of performing the various modify cart operations

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ALL_PRODUCTS_ATTRIBUTE_NAME
protected boolean	automaticallyAddCompleteItems
protected static String	cartPageRedirect
protected static String	cartView
protected static String	checkoutView
protected static String	configurePageRedirect
protected static String	configureView

Fields inherited from class org.broadleafcommerce.core.web.controller.cart.AbstractCartController

catalogService, dtoTranslationService, offerService, orderItemService, orderService, updateCartService

Constructor Summary

Constructors

Constructor	Description
BroadleafCartController()

Method Summary

Modifier and Type	Method	Description
String	add(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, OrderItemRequestDTO itemRequest)	Takes in an item request, adds the item to the customer's current cart, and returns.
String	addPromo(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, String customerOffer)	Attempts to add provided Offer to Cart
String	addWithPriceOverride(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest)	Deprecated.
String	addWithPriceOverride(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, OrderItemRequestDTO itemRequest)	Takes in an item request, adds the item to the customer's current cart, and returns.
String	cart(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model)	Renders the cart page.
String	configure(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Long productId)	Takes a product id and builds out a dependant order item tree.
String	empty(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model)	Cancels the current cart and redirects to the homepage
String	getCartPageRedirect()
String	getCartView()
String	getCheckoutView()
String	getConfigurePageRedirect()
String	getConfigureView()
Map<String,String>	handleIllegalCartOpException(IllegalCartOperationException ex)
protected boolean	isCheckoutContext(jakarta.servlet.http.HttpServletRequest request)
protected boolean	isSafeToAdd(ConfigurableOrderItemRequest itemRequest)
protected boolean	isUpdateRequest(jakarta.servlet.http.HttpServletRequest request)
String	reconfigure(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Long orderItemId)	Takes an order item id and rebuilds the dependant order item tree with the current quantities and options set.
String	remove(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, OrderItemRequestDTO itemRequest)	Takes in an item request, updates the quantity of that item in the cart, and returns
String	removePromo(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Long offerCodeId)	Removes offer from cart
protected void	updateAddRequestQuantities(OrderItemRequestDTO itemRequest, Long originalOrderItemId)
String	updateQuantity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, AddToCartItem itemRequest)	Deprecated.
String	updateQuantity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, OrderItemRequestDTO itemRequest)	Takes in an item request and updates the quantity of that item in the cart.

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

addDeepLink, getContextPath, isAjaxRequest, jsonResponse

Methods inherited from class java.lang.Object

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

Field Details

cartView

protected static String cartView

checkoutView

protected static String checkoutView

cartPageRedirect

protected static String cartPageRedirect

configureView

protected static String configureView

configurePageRedirect

protected static String configurePageRedirect

ALL_PRODUCTS_ATTRIBUTE_NAME

protected static String ALL_PRODUCTS_ATTRIBUTE_NAME

automaticallyAddCompleteItems

@Value("${automatically.add.complete.items}")
protected boolean automaticallyAddCompleteItems

Constructor Details

BroadleafCartController

public BroadleafCartController()

Method Details

cart

public String cart(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model)
            throws PricingException

Renders the cart page.

If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will render the "cart" template.

Will reprice the order if the currency has been changed.

Parameters:

request -

response -

model -

Throws:

PricingException

add

public String add(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 OrderItemRequestDTO itemRequest)
           throws IOException,
AddToCartException,
PricingException,
NumberFormatException,
RemoveFromCartException,
IllegalArgumentException

Takes in an item request, adds the item to the customer's current cart, and returns.

If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

IOException

AddToCartException

PricingException

RemoveFromCartException

NumberFormatException

IllegalArgumentException

updateAddRequestQuantities

protected void updateAddRequestQuantities(OrderItemRequestDTO itemRequest,
 Long originalOrderItemId)

isUpdateRequest

protected boolean isUpdateRequest(jakarta.servlet.http.HttpServletRequest request)

addWithPriceOverride

public String addWithPriceOverride(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 OrderItemRequestDTO itemRequest)
                            throws IOException,
AddToCartException,
PricingException

Takes in an item request, adds the item to the customer's current cart, and returns.

Calls the addWithOverrides method on the orderService which will honor the override prices on the OrderItemRequestDTO request object.

Implementors must secure this method to avoid accidentally exposing the ability for malicious clients to override prices by hacking the post parameters.

Parameters:

request -

response -

model -

itemRequest -

Throws:

IOException

AddToCartException

PricingException

addWithPriceOverride

@Deprecated
public String addWithPriceOverride(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 AddToCartItem itemRequest)
                            throws IOException,
AddToCartException,
PricingException

Deprecated.

Throws:

IOException

AddToCartException

PricingException

configure

public String configure(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 Long productId)
                 throws IOException,
AddToCartException,
PricingException,
Exception

Takes a product id and builds out a dependant order item tree. If it determines the order item is safe to add, it will proceed to calling the "add" method.

If the method was invoked via an AJAX call, it will render the "ajax/configure" template. Otherwise, it will perform a 302 redirect to "/cart/configure"

In the case that an "add" happened it will render either the "ajax/cart" or perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

productId -

Throws:

IOException

AddToCartException

PricingException

Exception

reconfigure

public String reconfigure(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 Long orderItemId)
                   throws IOException,
AddToCartException,
PricingException,
Exception

Takes an order item id and rebuilds the dependant order item tree with the current quantities and options set.

If the method was invoked via an AJAX call, it will render the "ajax/configure" template. Otherwise, it will perform a 302 redirect to "/cart/configure"

Parameters:

request -

response -

model -

orderItemId -

Throws:

IOException

AddToCartException

PricingException

Exception

updateQuantity

public String updateQuantity(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 OrderItemRequestDTO itemRequest)
                      throws IOException,
UpdateCartException,
PricingException,
RemoveFromCartException

Takes in an item request and updates the quantity of that item in the cart. If the quantity was passed in as 0, it will remove the item.

If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

IOException

PricingException

UpdateCartException

RemoveFromCartException

updateQuantity

@Deprecated
public String updateQuantity(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 AddToCartItem itemRequest)
                      throws IOException,
UpdateCartException,
PricingException,
RemoveFromCartException

Deprecated.

Throws:

IOException

UpdateCartException

PricingException

RemoveFromCartException

remove

public String remove(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 OrderItemRequestDTO itemRequest)
              throws IOException,
PricingException,
RemoveFromCartException

Takes in an item request, updates the quantity of that item in the cart, and returns

If the method was invoked via an AJAX call, it will render the "ajax/cart" template. Otherwise, it will perform a 302 redirect to "/cart"

Parameters:

request -

response -

model -

itemRequest -

Throws:

IOException

PricingException

RemoveFromCartException

empty

public String empty(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model)
             throws PricingException

Cancels the current cart and redirects to the homepage

Parameters:

request -

response -

model -

Throws:

PricingException

addPromo

public String addPromo(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 String customerOffer)
                throws IOException,
PricingException

Attempts to add provided Offer to Cart

Parameters:

request -

response -

model -

customerOffer -

Returns:

the return view

Throws:

IOException

PricingException

OfferMaxUseExceededException

isCheckoutContext

protected boolean isCheckoutContext(jakarta.servlet.http.HttpServletRequest request)

removePromo

public String removePromo(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.ui.Model model,
 Long offerCodeId)
                   throws IOException,
PricingException

Removes offer from cart

Parameters:

request -

response -

model -

Returns:

the return view

Throws:

IOException

PricingException

OfferMaxUseExceededException

getCartView

public String getCartView()

getCartPageRedirect

public String getCartPageRedirect()

getConfigureView

public String getConfigureView()

getConfigurePageRedirect

public String getConfigurePageRedirect()

getCheckoutView

public String getCheckoutView()

handleIllegalCartOpException

public Map<String,String> handleIllegalCartOpException(IllegalCartOperationException ex)

isSafeToAdd

protected boolean isSafeToAdd(ConfigurableOrderItemRequest itemRequest)