com.adobe.cq.commerce.common

Class AbstractJcrCommerceService

java.lang.Object

com.adobe.cq.commerce.common.AbstractJcrCommerceService

All Implemented Interfaces:

CommerceService

public abstract class AbstractJcrCommerceService
extends java.lang.Object
implements CommerceService

An abstract base class for implementing CommerceServices on top of the JCR repository. See GeoCommerceServiceImpl for an example.

Field Summary

Fields

Modifier and Type	Field and Description
AbstractJcrCommerceServiceFactory.Services	services Deprecated. use the serviceContext field instead.

Constructor Summary

Constructors

Constructor and Description
AbstractJcrCommerceService(AbstractJcrCommerceServiceFactory.Services services) Deprecated. since 5.6.1; use AbstractJcrCommerceService(ServiceContext) instead.

Method Summary

Modifier and Type	Method and Description
void	catalogRolloutHook(Page blueprint, Page catalog) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
java.lang.Object[]	deserializeCartEntryData(java.lang.String str) Creates cart entry data from a String created with serializeCartEntryData(String, int, org.apache.sling.api.resource.ValueMap).
java.util.List<PaymentMethod>	getAvailablePaymentMethods() Returns a list of available payment methods.
java.util.List<Promotion>	getAvailablePromotions(ResourceResolver resourceResolver) Returns a list of JCR-based promotions (ie, those known to the PromotionManager).
java.util.List<ShippingMethod>	getAvailableShippingMethods() Returns a list of available shipping methods.
java.util.Map<java.lang.String,java.lang.Object>	getContext() Get the context or an empty map if no context has been set before via CommerceService.setContext(Map).
VendorJcrPlacedOrder	getPlacedOrder(java.lang.String orderId, java.util.Locale locale) Return a vendor record of a placed order for order administration.
ProductCollection	getProductCollection(java.lang.String path) Default implementation assumes a JCR-based product collection (in which the path parameter is truly a path).
Promotion	getPromotion(java.lang.String path) Default implementation assumes a JCR-based promotion (in which the path parameter is truly a path).
java.lang.String	getServer() Get the configured commerce server endpoint.
Voucher	getVoucher(java.lang.String path) Default implementation assumes a JCR-based voucher (in which the path parameter is truly a path).
boolean	isActivated(Product product) Check for public availability of a product.
DefaultJcrCartEntry	newCartEntryImpl(int index, Product product, int quantity) Instantiates a new cart entry.
void	productRolloutHook(Product productData, Page productPage, Product productReference) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
CommerceResult	search(CommerceQuery query) Perform a search.
void	sectionRolloutHook(Page blueprint, Page section) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
java.lang.String	serializeCartEntryData(java.lang.String productPath, int quantity, ValueMap properties) Converts the cart entry data to a String of the form "productPath;quantity;property1_name=property1_value\fproperty2_name=property2_value\f...".
ServiceContext	serviceContext() Returns the ServiceContext of this service.
void	setContext(java.util.Map<java.lang.String,java.lang.Object> context) Set a context for this service instance and any session retrieved from it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.commerce.api.CommerceService

getCountries, getCreditCardTypes, getOrderPredicates, getProduct, isAvailable, login

Field Detail

services

@Deprecated
public AbstractJcrCommerceServiceFactory.Services services

Deprecated. use the serviceContext field instead.

Constructor Detail

AbstractJcrCommerceService

@Deprecated
public AbstractJcrCommerceService(AbstractJcrCommerceServiceFactory.Services services)

Deprecated. since 5.6.1; use AbstractJcrCommerceService(ServiceContext) instead.

Method Detail

serviceContext

public ServiceContext serviceContext()

Returns the ServiceContext of this service.

setContext

public void setContext(java.util.Map<java.lang.String,java.lang.Object> context)

Set a context for this service instance and any session retrieved from it. Service and session implementations may send the context with requests to remote commerce providers.

Note that the context is not persisted across requests and needs to be set again when creating a new service instance.

Specified by:

setContext in interface CommerceService

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()

Get the context or an empty map if no context has been set before via CommerceService.setContext(Map).

Specified by:

getContext in interface CommerceService

Returns:

the context

getServer

public java.lang.String getServer()

Get the configured commerce server endpoint.

Specified by:

getServer in interface CommerceService

Returns:

isActivated

public boolean isActivated(Product product)
                    throws CommerceException

Check for public availability of a product.

Specified by:

isActivated in interface CommerceService

Returns:

true if publicly available

Throws:

CommerceException

getPromotion

public Promotion getPromotion(java.lang.String path)
                       throws CommerceException

Default implementation assumes a JCR-based promotion (in which the path parameter is truly a path).

Specified by:

getPromotion in interface CommerceService

Returns:

The promotion or null if not found.

Throws:

CommerceException

getVoucher

public Voucher getVoucher(java.lang.String path)
                   throws CommerceException

Default implementation assumes a JCR-based voucher (in which the path parameter is truly a path).

Specified by:

getVoucher in interface CommerceService

Returns:

The voucher or null if not found.

Throws:

CommerceException

getProductCollection

public ProductCollection getProductCollection(java.lang.String path)
                                       throws CommerceException

Default implementation assumes a JCR-based product collection (in which the path parameter is truly a path).

Specified by:

getProductCollection in interface CommerceService

Returns:

The product collection or null if not found.

Throws:

CommerceException

getPlacedOrder

public VendorJcrPlacedOrder getPlacedOrder(java.lang.String orderId,
                                           java.util.Locale locale)

Return a vendor record of a placed order for order administration. The given locale will be used to format prices.

catalogRolloutHook

public void catalogRolloutHook(Page blueprint,
                               Page catalog)
                        throws CommerceException

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The catalogRolloutHook is called after the root catalog page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Specified by:

catalogRolloutHook in interface CommerceService

Parameters:

blueprint - The catalog blueprint.

catalog - The catalog page created from the blueprint.

Throws:

CommerceException

sectionRolloutHook

public void sectionRolloutHook(Page blueprint,
                               Page section)

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The sectionRolloutHook is called after each section page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Specified by:

sectionRolloutHook in interface CommerceService

Parameters:

blueprint - The catalog section blueprint.

section - The section page created from the blueprint.

productRolloutHook

public void productRolloutHook(Product productData,
                               Page productPage,
                               Product productReference)
                        throws CommerceException

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The productRolloutHook is called after each product page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Specified by:

productRolloutHook in interface CommerceService

Parameters:

productData - The productData for which the product page was created.

productPage - The product page created from the section blueprint's product template.

productReference - The product reference on the created/updated page.

Throws:

CommerceException

search

public CommerceResult search(CommerceQuery query)
                      throws CommerceException

Perform a search.

Specified by:

search in interface CommerceService

Parameters:

query - The query representing the search parameters

Returns:

a CommerceResult representing the search results

Throws:

CommerceException

getAvailablePromotions

public java.util.List<Promotion> getAvailablePromotions(ResourceResolver resourceResolver)
                                                 throws CommerceException

Returns a list of JCR-based promotions (ie, those known to the PromotionManager).

Specified by:

getAvailablePromotions in interface CommerceService

Parameters:

resourceResolver - a Sling ResourceResolver instance

Returns:

A List<Promotion> containing the promotions.

Throws:

CommerceException

getAvailableShippingMethods

public java.util.List<ShippingMethod> getAvailableShippingMethods()
                                                           throws CommerceException

Returns a list of available shipping methods.

NB: not in the public interface. All public access should be through CommerceSession.getAvailableShippingMethods().

Implementations which support session- or order-specific shipping methods should implement AbstractJcrCommerceSession.getAvailableShippingMethods() instead.

This implementation picks up the shipping methods from the JCR repository. Override to specify a more-specific path or a particular ShippingMethod implementation.

Throws:

CommerceException

getAvailablePaymentMethods

public java.util.List<PaymentMethod> getAvailablePaymentMethods()
                                                         throws CommerceException

Returns a list of available payment methods.

NB: not in the public interface. All public access should be through CommerceSession.getAvailablePaymentMethods().

Implementations which support session- or order-specific shipping methods should implement AbstractJcrCommerceSession.getAvailablePaymentMethods() instead.

This implementation picks up the payment methods from the JCR repository. Override to specify a more-specific path or a particular PaymentMethod implementation.

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.

serializeCartEntryData

public java.lang.String serializeCartEntryData(java.lang.String productPath,
                                               int quantity,
                                               ValueMap properties)

Converts the cart entry data to a String of the form "productPath;quantity;property1_name=property1_value\fproperty2_name=property2_value\f...".

Parameters:

productPath - the path of the product of the cart entry

quantity - the number of products in the cart entry

properties - other cart entry properties

Returns:

the String representation of cart entry data

deserializeCartEntryData

public java.lang.Object[] deserializeCartEntryData(java.lang.String str)
                                            throws CommerceException

Creates cart entry data from a String created with serializeCartEntryData(String, int, org.apache.sling.api.resource.ValueMap).

Parameters:

str - the serialized cart entry data

Returns:

the an Object[] of length 3 which contains the Product object at index 0, the quantity Integer object at index 1 and null or a Map<String, Object> holding the other properties of the cart entry at index 2.

Throws:

CommerceException