atg.commerce.catalog.restresources

Class AbstractCatalogRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.restresources.AbstractItemLookupRestResource

atg.commerce.catalog.restresources.AbstractCatalogRestResource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

CategoryRestResource, ProductRestResource, SkuRestResource

public class AbstractCatalogRestResource
extends AbstractItemLookupRestResource

This class is the common class to assist the rest endpoint catalog data retrieval. Products, skus and categories can be retrieved in a generic way.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

COLLECTION_MISSING_INPUT_PARAMS, COLLECTION_PARENT_ITEM_NOT_FOUND, COLLECTION_PARENT_REPOSITORY_NOT_FOUND, COLLECTION_PROPERTY_INVALID, COLLECTION_PROPERTY_NOT_FOUND, COLLECTION_SORT_SIZE, COMMA, DEFAULT_PAGE_SIZE, ID, INVALID_QUERY_PARAMS, ITEM, ITEM_DESCRIPTOR_NOT_SUPPLIED, ITEM_NOT_FOUND, mEmbeddedRelationshipToResourceId, mRepository, PARENT_ITEM_ID, PARENT_ITEM_TYPE, PARENT_PROPERTY_NAME, REQUEST_DATA_KEY_PREFIX, RESOURCE_NAME, SEPARATOR, sResourceBundle, UNEXPECTED_ERROR

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
AbstractCatalogRestResource()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	buildInputs(java.lang.String pItemId, java.lang.Boolean pFilterByCatalogFlag, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId) Helper method to build the inputs that will be passed in as params to the
void	embedParentCategory(RepresentationModel.Builder pBuilder, RepositoryItem pItem, java.lang.String pRelationshipName) Embed the parentCategory resource for the item and relationship name passed in
CustomCatalogTools	getCatalogTools() Get CatalogTools used for manipulating catalog data
RepositoryItem	getItem(java.lang.String pItemId, java.lang.Boolean pFilterByCatalogFlag, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId) Get the catalog item matching the id passed.
protected DropletInvoker	postInvoker(DropletInvoker pInvoker, java.util.Map<java.lang.String,java.lang.Object> pParams) Catalog specific post processing required after the droplet is invoked.
protected DropletInvoker	preInvoker(DropletInvoker pInvoker, java.util.Map<java.lang.String,java.lang.Object> pParams) Sets the catalog specific inputs parameters before invoking the CatalogItemLookupDroplet.
protected RepositoryItem	retrieveItem(DropletInvoker pInvoker) Retrieve item returned by the droplet.
void	setCatalogTools(CustomCatalogTools pCatalogTools) Sets CatalogTools for manipulating catalog data

Methods inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

addEmbeddedCollectionResource, addEmbeddedCollectionResources, buildInputs, generateRequestDataKey, getCollectionSortLimit, getDefaultLimit, getDroplet, getEmbeddedRelationshipToResourceId, getItem, getItemDescriptor, getParentRepositoryItem, getRepository, getRepresentationModelBuilder, listItems, listItems, listItems, retrieveRequestData, setCollectionSortLimit, setDefaultLimit, setDroplet, setEmbeddedRelationshipToResourceId, setItemDescriptor, setRepository, validateProperty

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

AbstractCatalogRestResource

public AbstractCatalogRestResource()

Method Detail

getCatalogTools

public CustomCatalogTools getCatalogTools()

Get CatalogTools used for manipulating catalog data

Returns:

CatalogTools

setCatalogTools

public void setCatalogTools(CustomCatalogTools pCatalogTools)

Sets CatalogTools for manipulating catalog data

Parameters:

pCatalogTools - the new CatalogTools

embedParentCategory

public void embedParentCategory(RepresentationModel.Builder pBuilder,
                                RepositoryItem pItem,
                                java.lang.String pRelationshipName)

Embed the parentCategory resource for the item and relationship name passed in

Parameters:

pBuilder - the model builder used to embed the link.

pItem - the item (category/product) that has the parentCategory.

pRelationshipName - the relationship name of the embedded resource.

getItem

public RepositoryItem getItem(java.lang.String pItemId,
                              java.lang.Boolean pFilterByCatalogFlag,
                              java.lang.Boolean pFilterBySiteFlag,
                              java.lang.String pSiteId)
                       throws RestException

Get the catalog item matching the id passed. This is a generic method that can get product/sku/category items. The useParams property of this droplet needs to be set to true for the filter flags to be used. Otherwise these filterByCatalogFlag & filterBySiteFlag flags will be ignored. The filterByCatalogFlag will filter by the user's catalog. The user's catalog is expected to be set via the pipeline process. For B2B it can be set explicitly. If no user's catalog is defined then the filterByCatalogFlag will be ignored and the item returned. The FilterBySiteFlag will filter by the siteId. If siteId is not set it will filter by the current site context.

Parameters:

pItemId - the id of the catalog item to find

pFilterByCatalogFlag - if true only find the item if the item's catalog matches the users catalog.

pFilterBySiteFlag - if true only find the item if it matches siteId or the current site context

pSiteId - the id of the site the item should belong too

Returns:

the RepresentationModel containing the catalog item and the state details

Throws:

RestException - the rest exception

preInvoker

protected DropletInvoker preInvoker(DropletInvoker pInvoker,
                                    java.util.Map<java.lang.String,java.lang.Object> pParams)

Sets the catalog specific inputs parameters before invoking the CatalogItemLookupDroplet.

Overrides:

preInvoker in class AbstractItemLookupRestResource

Parameters:

pInvoker - the invoker

pParams - the params

Returns:

the droplet invoker

postInvoker

protected DropletInvoker postInvoker(DropletInvoker pInvoker,
                                     java.util.Map<java.lang.String,java.lang.Object> pParams)
                              throws RestException

Catalog specific post processing required after the droplet is invoked.

Overrides:

postInvoker in class AbstractItemLookupRestResource

Parameters:

pInvoker - the invoker

pParams - the params

Returns:

the droplet invoker

Throws:

RestException - the rest exception

retrieveItem

protected RepositoryItem retrieveItem(DropletInvoker pInvoker)

Retrieve item returned by the droplet. If the normal OUTPUT oparam isn't passed back we still need to check the noCatalog oparam is in order to pass the item back.

For the storefront we don't support the profile's catalog not being set therefore generally the noCatalog oparam won't be encountered however as it's possible we handle it. It may be useful in an admin-style call where user/user's catalog may not be set. This behaviour can be overridden if required.

Overrides:

retrieveItem in class AbstractItemLookupRestResource

Parameters:

pInvoker - the invoker

Returns:

the item returned by the droplet

Throws:

RestException - the rest exception

buildInputs

public java.util.Map<java.lang.String,java.lang.Object> buildInputs(java.lang.String pItemId,
                                                                    java.lang.Boolean pFilterByCatalogFlag,
                                                                    java.lang.Boolean pFilterBySiteFlag,
                                                                    java.lang.String pSiteId)

Helper method to build the inputs that will be passed in as params to the

Parameters:

pItemId - the item id

pFilterBySiteFlag - the filter by site flag

pSiteId - the site id

Returns:

the map