com.adobe.cq.commerce.common

Class AbstractJcrCommerceSession

java.lang.Object

com.adobe.cq.commerce.common.AbstractJcrCommerceSession

All Implemented Interfaces:

CommerceSession

public class AbstractJcrCommerceSession
extends Object
implements CommerceSession

This class is meant to be used as a base class for a CommerceSession implementation built on top of a JCR repository. GeoCommerceSessionImpl is an example. Parts of this class form a reference implementation. That is, they are meant to show what would be needed in an actual implementation, but aren't in themselves likely to be sufficient for real-world cases.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.commerce.api.CommerceSession

CommerceSession.CartEntry

Constructor Summary

Constructors

Constructor and Description
AbstractJcrCommerceSession(AbstractJcrCommerceService commerceService, SlingHttpServletRequest request, SlingHttpServletResponse response, Resource resource)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCartEntry(Product product, int quantity) Add a new entry to the cart.
void	addPromotion(String path) Adds a client-side-resolved promotion to the current session.
void	addVoucher(String code) Add a Voucher, identified by its code, to the cart.
void	calcEntry(int index) Recalculates the pricing info of an entry in the cart.
void	deleteCartEntry(int entryNumber) Delete an existing cart entry.
List<Promotion>	getActivePromotions() Returns the list of currently active promotions (including those fired by vouchers).
List<CommerceSession.CartEntry>	getCartEntries() Get the cart entries as a List.
int	getCartEntryCount() Get the number of cart entries.
String	getCartPreTaxPrice() Deprecated.
String	getCartPrice(Predicate filter) Shortcut for getting a formatted string of the first applicable price, according to the filter.
List<PriceInfo>	getCartPriceInfo(Predicate filter) Get detailed price information about the cart filtered by the provided predicate (usually a PriceFilter).
String	getCartTax() Deprecated.
String	getCartTotalPrice() Deprecated.
Map<String,Object>	getOrder() Get the current order details.
Map<String,String>	getOrderDetails()
String	getOrderId() Return an ID uniquely identifying the current order.
String	getOrderShipping() Deprecated.
String	getOrderTotalPrice() Deprecated.
String	getOrderTotalTax() Deprecated.
PlacedOrder	getPlacedOrder(String orderId) Fetch a specific (previously-placed) order.
PlacedOrderResult	getPlacedOrders(String predicate, int pageNumber, int pageSize, String sortId) Returns a list of placed orders for the current shopper.
String	getPriceInfo(Product product) Deprecated.
String	getProductPrice(Product product) Shortcut for getting a formatted string for the first price for a product.
String	getProductPrice(Product product, Predicate filter) Shortcut for getting a formatted string for the first applicable price for a product as defined by the provided predicate (usually a PriceFilter).
List<PriceInfo>	getProductPriceInfo(Product product) Get a list of all detailed price infos for a product See PriceInfo for more details.
List<PriceInfo>	getProductPriceInfo(Product product, Predicate filter) A simple product pricing architecture supporting single-currency pricing and a fixed tax rate.
List<PromotionInfo>	getPromotions() A CQ-centric implementation which assumes all promotion resolution is done on the client.
String	getShippingPrice(String method) Deprecated.
Locale	getUserLocale() Return the forced user locale or null, if no locale was set before.
List<VoucherInfo>	getVoucherInfos() Return a list of vouchers that were added to the cart via addVoucher(String), complete with run-time details such as shopper messages and applied discount information.
List<Voucher>	getVouchers() Deprecated. since 6.0; use getVoucherInfos() instead
static boolean	hasCookieOverflow(SlingHttpServletRequest request, SlingHttpServletResponse response) Returns true if an overflow is detected on the commerce persistence cookie.
void	logout() Logout is a NO-OP in this implementation.
void	modifyCartEntry(int entryNumber, int quantity) Modify quantity of an existing cart entry.
DefaultJcrCartEntry	newCartEntryImpl(int index, Product product, int quantity) Instantiates a new cart entry.
DefaultJcrPlacedOrder	newPlacedOrderImpl(String orderId) Instantiates a new placed order.
void	placeOrder(Map<String,Object> delta) Submit the current order.
void	removePromotion(String path) Remove a promotion.
void	removeVoucher(String code) Remove all Vouchers from the cart which match a particular voucher code.
void	setUserLocale(Locale locale) Set the userLocale (which, if non-null, overrides the default locale).
void	submitOrder(Map<String,String> orderDetailsDelta) Deprecated.
boolean	supportsClientsidePromotionResolution() Client-side promotion resolution allows a ClientContext store (the CartMgr in the OOTB implementation) to resolve promotions and then adjust the current CommerceSession via CommerceSession.addPromotion(String) and CommerceSession.removePromotion(String).
void	updateOrder(Map<String,Object> delta) Update a subset of the current order details.
void	updateOrderDetails(Map<String,String> delta) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJcrCommerceSession

public AbstractJcrCommerceSession(AbstractJcrCommerceService commerceService,
                          SlingHttpServletRequest request,
                          SlingHttpServletResponse response,
                          Resource resource)
                           throws CommerceException

Throws:

CommerceException

Method Detail

hasCookieOverflow

public static boolean hasCookieOverflow(SlingHttpServletRequest request,
                        SlingHttpServletResponse response)

Returns true if an overflow is detected on the commerce persistence cookie.

logout

public void logout()
            throws CommerceException

Logout is a NO-OP in this implementation.

To be overridden by concrete implementations requiring logout semantics (such as those employing session state).

Specified by:

logout in interface CommerceSession

Throws:

CommerceException

setUserLocale

public void setUserLocale(Locale locale)

Set the userLocale (which, if non-null, overrides the default locale).

Specified by:

setUserLocale in interface CommerceSession

getUserLocale

public Locale getUserLocale()

Description copied from interface: CommerceSession

Return the forced user locale or null, if no locale was set before.

Specified by:

getUserLocale in interface CommerceSession

getProductPriceInfo

public List<PriceInfo> getProductPriceInfo(Product product)
                                    throws CommerceException

Description copied from interface: CommerceSession

Get a list of all detailed price infos for a product See PriceInfo for more details.

Specified by:

getProductPriceInfo in interface CommerceSession

Throws:

CommerceException

getProductPriceInfo

public List<PriceInfo> getProductPriceInfo(Product product,
                                  Predicate filter)
                                    throws CommerceException

A simple product pricing architecture supporting single-currency pricing and a fixed tax rate.

Note: most concrete implementations will want to override this to supply their own pricing architecture.

Specified by:

getProductPriceInfo in interface CommerceSession

Parameters:

product - The product.

filter - An optional predicate used for filtering the PriceInfos. Pass null to fetch all PriceInfos.

Returns:

A list of all PriceInfos which match the provided predicate.

Throws:

CommerceException

getProductPrice

public String getProductPrice(Product product)
                       throws CommerceException

Description copied from interface: CommerceSession

Shortcut for getting a formatted string for the first price for a product.

See PriceInfo for more details.

Specified by:

getProductPrice in interface CommerceSession

Parameters:

product - The product.

Returns:

A formatted price string.

Throws:

CommerceException

getProductPrice

public String getProductPrice(Product product,
                     Predicate filter)
                       throws CommerceException

Description copied from interface: CommerceSession

Shortcut for getting a formatted string for the first applicable price for a product as defined by the provided predicate (usually a PriceFilter).

See PriceInfo for more details.

Specified by:

getProductPrice in interface CommerceSession

Parameters:

product - The product

filter - An optional predicate used for filtering the PriceInfos. Pass null to fetch all PriceInfos.

Returns:

A formatted price string.

Throws:

CommerceException

getCartEntryCount

public int getCartEntryCount()

Description copied from interface: CommerceSession

Get the number of cart entries.

Specified by:

getCartEntryCount in interface CommerceSession

getCartEntries

public List<CommerceSession.CartEntry> getCartEntries()

Description copied from interface: CommerceSession

Get the cart entries as a List.

Specified by:

getCartEntries in interface CommerceSession

getCartPriceInfo

public List<PriceInfo> getCartPriceInfo(Predicate filter)

Description copied from interface: CommerceSession

Get detailed price information about the cart filtered by the provided predicate (usually a PriceFilter).

Current components expect the following prices, in this order:

1. "CART" (cart subtotal, generally pre-tax)
2. "ORDER" (order total, generally including tax and shipping)

Examples:

 // get the cart subtotal
 session.getCartPrice(null);
 // get cart total
 session.getCartPrice(new PriceFilter("POST_TAX"));
 // get order tax
 session.getCartPrice(new PriceFilter("ORDER", "TAX"));
 
 

Specified by:

getCartPriceInfo in interface CommerceSession

Parameters:

filter - An optional predicate used for filtering the PriceInfos. Pass null to fetch all PriceInfos.

Returns:

a list of prices, can be empty if no price matches.

getCartPrice

public String getCartPrice(Predicate filter)
                    throws CommerceException

Description copied from interface: CommerceSession

Shortcut for getting a formatted string of the first applicable price, according to the filter.

Specified by:

getCartPrice in interface CommerceSession

Parameters:

filter - An optional predicate used for filtering the PriceInfos. Pass null to fetch all PriceInfos.

Returns:

Formatted price string of first matching price

Throws:

CommerceException

See Also:

CommerceSession.getCartPriceInfo(Predicate)

addCartEntry

public void addCartEntry(Product product,
                int quantity)
                  throws CommerceException

Description copied from interface: CommerceSession

Add a new entry to the cart.

Specified by:

addCartEntry in interface CommerceSession

Parameters:

product - The product to add

quantity - The number of items to add

Throws:

CommerceException

newCartEntryImpl

public DefaultJcrCartEntry newCartEntryImpl(int index,
                                   Product product,
                                   int quantity)

Instantiates a new cart entry. Override this method to supply custom extensions of DefaultJcrCartEntry.

Parameters:

index - The index of the entry with the current cart or PlacedOrder.

product - The product the new entry represents.

quantity - The quantity.

modifyCartEntry

public void modifyCartEntry(int entryNumber,
                   int quantity)
                     throws CommerceException

Description copied from interface: CommerceSession

Modify quantity of an existing cart entry.

Specified by:

modifyCartEntry in interface CommerceSession

Parameters:

entryNumber - The cart entry's number

quantity - The new quantity

Throws:

CommerceException

deleteCartEntry

public void deleteCartEntry(int entryNumber)
                     throws CommerceException

Description copied from interface: CommerceSession

Delete an existing cart entry.

Specified by:

deleteCartEntry in interface CommerceSession

Parameters:

entryNumber - The cart entry's number

Throws:

CommerceException

calcEntry

public void calcEntry(int index)
               throws CommerceException

Recalculates the pricing info of an entry in the cart.

Parameters:

index - The index of the entry.

Throws:

CommerceException

getActivePromotions

public List<Promotion> getActivePromotions()

Returns the list of currently active promotions (including those fired by vouchers).

Returns:

List of active promotions

supportsClientsidePromotionResolution

public boolean supportsClientsidePromotionResolution()

Description copied from interface: CommerceSession

Client-side promotion resolution allows a ClientContext store (the CartMgr in the OOTB implementation) to resolve promotions and then adjust the current CommerceSession via CommerceSession.addPromotion(String) and CommerceSession.removePromotion(String). In contrast, if a CommerceSession wishes to resolve its own promotions on the server, it should return false here and need only implement CommerceSession.getPromotions() to return the resolved promotion info.

Specified by:

supportsClientsidePromotionResolution in interface CommerceSession

Returns:

true if underlying implementation has support

addPromotion

public void addPromotion(String path)
                  throws CommerceException

Adds a client-side-resolved promotion to the current session.

Specified by:

addPromotion in interface CommerceSession

Parameters:

path - A string uniquely identifying the promotion (the path for internal Promotions; an id for external ones).)

Throws:

CommerceException

removePromotion

public void removePromotion(String path)
                     throws CommerceException

Description copied from interface: CommerceSession

Remove a promotion.

Specified by:

removePromotion in interface CommerceSession

Parameters:

path - A string uniquely identifying the promotion (generally a path)

Throws:

CommerceException

getPromotions

public List<PromotionInfo> getPromotions()
                                  throws CommerceException

A CQ-centric implementation which assumes all promotion resolution is done on the client. The list of promotions is therefore exactly what was set by calls to add/removePromotion().

To be overridden by concrete implementations wishing to provide external-commerce-engine-resolved promotions (either exclusively or in addition to CQ-resolved promotions).

Specified by:

getPromotions in interface CommerceSession

Throws:

CommerceException

getVoucherInfos

public List<VoucherInfo> getVoucherInfos()
                                  throws CommerceException

Return a list of vouchers that were added to the cart via addVoucher(String), complete with run-time details such as shopper messages and applied discount information.

Specified by:

getVoucherInfos in interface CommerceSession

Throws:

CommerceException

addVoucher

public void addVoucher(String code)
                throws CommerceException

Add a Voucher, identified by its code, to the cart. Invalid vouchers will result in a CommerceException with an internationalized message regarding the validity status.

Specified by:

addVoucher in interface CommerceSession

Parameters:

code - the voucher's code

Throws:

CommerceException

removeVoucher

public void removeVoucher(String code)
                   throws CommerceException

Remove all Vouchers from the cart which match a particular voucher code.

Specified by:

removeVoucher in interface CommerceSession

Parameters:

code - the voucher's code

Throws:

CommerceException

getOrderId

public String getOrderId()
                  throws CommerceException

Return an ID uniquely identifying the current order.

Specified by:

getOrderId in interface CommerceSession

Returns:

A unique ID

Throws:

CommerceException

updateOrder

public void updateOrder(Map<String,Object> delta)
                 throws CommerceException

Description copied from interface: CommerceSession

Update a subset of the current order details. Entries in the Map which do not yet exist will be added to the order, while entries that already exist will be updated.

Specified by:

updateOrder in interface CommerceSession

Parameters:

delta - A Map of name/value pairs

Throws:

CommerceException

getOrderDetails

public Map<String,String> getOrderDetails()
                                   throws CommerceException

Specified by:

getOrderDetails in interface CommerceSession

Throws:

CommerceException

getOrder

public Map<String,Object> getOrder()
                            throws CommerceException

Description copied from interface: CommerceSession

Get the current order details.

Specified by:

getOrder in interface CommerceSession

Returns:

A Map of name/value pairs

Throws:

CommerceException

placeOrder

public void placeOrder(Map<String,Object> delta)
                throws CommerceException

Description copied from interface: CommerceSession

Submit the current order. Note that the semantics of submitting an order are somewhat implementation-dependent.

Specified by:

placeOrder in interface CommerceSession

Parameters:

delta - An optional set of order details to update before submission. Useful for passing properties which cannot be stored, such as the CCV.

Throws:

CommerceException

getPlacedOrders

public PlacedOrderResult getPlacedOrders(String predicate,
                                int pageNumber,
                                int pageSize,
                                String sortId)
                                  throws CommerceException

Returns a list of placed orders for the current shopper.

Specified by:

getPlacedOrders in interface CommerceSession

Parameters:

predicate - An optional implementation-specific predicate name.

pageNumber - the requested page number of the list of placed orders

pageSize - the number of orders in a page

sortId - the identifier of the sorting used to sort the list of placed orders

Returns:

a PlacedOrderResult object which contains the list of implementation-specific order summary info, the pagination and sorting info of the returned orders. If PaginationInfo is null in the returned object then the commerce implementation doesn't support pagination. If the returned object does not contain any CommerceSort object then the returned orders are unsorted.

Throws:

CommerceException

newPlacedOrderImpl

public DefaultJcrPlacedOrder newPlacedOrderImpl(String orderId)

Instantiates a new placed order. Override this method to supply custom extensions of DefaultJcrPlacedOrder.

Parameters:

orderId - The unique identifier of the order.

Returns:

getPlacedOrder

public PlacedOrder getPlacedOrder(String orderId)
                           throws CommerceException

Description copied from interface: CommerceSession

Fetch a specific (previously-placed) order.

Specified by:

getPlacedOrder in interface CommerceSession

Parameters:

orderId - An implementation-specific id identifying the placed order

Throws:

CommerceException

getPriceInfo

@Deprecated
public String getPriceInfo(Product product)
                    throws CommerceException

Deprecated.

Description copied from interface: CommerceSession

Get formatted price for a product.

Specified by:

getPriceInfo in interface CommerceSession

Throws:

CommerceException

getCartPreTaxPrice

@Deprecated
public String getCartPreTaxPrice()
                          throws CommerceException

Deprecated.

Specified by:

getCartPreTaxPrice in interface CommerceSession

Throws:

CommerceException

getCartTax

@Deprecated
public String getCartTax()
                  throws CommerceException

Deprecated.

Specified by:

getCartTax in interface CommerceSession

Throws:

CommerceException

getCartTotalPrice

@Deprecated
public String getCartTotalPrice()
                         throws CommerceException

Deprecated.

Specified by:

getCartTotalPrice in interface CommerceSession

Throws:

CommerceException

getOrderShipping

@Deprecated
public String getOrderShipping()
                        throws CommerceException

Deprecated.

Specified by:

getOrderShipping in interface CommerceSession

Throws:

CommerceException

getOrderTotalTax

@Deprecated
public String getOrderTotalTax()
                        throws CommerceException

Deprecated.

Specified by:

getOrderTotalTax in interface CommerceSession

Throws:

CommerceException

getOrderTotalPrice

@Deprecated
public String getOrderTotalPrice()
                          throws CommerceException

Deprecated.

Specified by:

getOrderTotalPrice in interface CommerceSession

Throws:

CommerceException

getShippingPrice

@Deprecated
public String getShippingPrice(String method)

Deprecated.

getVouchers

@Deprecated
public List<Voucher> getVouchers()
                          throws CommerceException

Deprecated. since 6.0; use getVoucherInfos() instead

Description copied from interface: CommerceSession

Get a list of vouchers that were added to this cart via CommerceSession.addVoucher(String).

Specified by:

getVouchers in interface CommerceSession

Throws:

CommerceException

updateOrderDetails

@Deprecated
public void updateOrderDetails(Map<String,String> delta)
                        throws CommerceException

Deprecated.

Specified by:

updateOrderDetails in interface CommerceSession

Throws:

CommerceException

submitOrder

@Deprecated
public void submitOrder(Map<String,String> orderDetailsDelta)
                 throws CommerceException

Deprecated.

Specified by:

submitOrder in interface CommerceSession

Throws:

CommerceException