atg.projects.store.recommendations.processor

Class TrackingCodeProcessor

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.adc.pipeline.ADCPipelineProcessor

atg.adc.pipeline.ADCEventPipelineProcessor

atg.projects.store.recommendations.processor.TrackingCodeProcessor

All Implemented Interfaces:

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

Direct Known Subclasses:

CategoryTrackingCodeProcessor, OrderSubmitProcessor, ProductTrackingCodeProcessor, SearchResultsProcessor

public class TrackingCodeProcessor
extends atg.adc.pipeline.ADCEventPipelineProcessor

This processor is responsible for generating base clickstream tracking code markup that is included into all pages. The tracking code generated by this processor includes the following parameter:

• retailer ID
• customer ID (for non-transient profiles)
• store ID (for multisite context)
• excludeDefaultStore (for multisite context and the value is true)
• -inc-price (optional)
• locale (optional)
• cart (included only if one of the configured JMSTypes events present)
• -failover (included only if non default configuration is used)

Upon completion of tracking code generating the processor will append it to the current auto-tagging data stored in ADC pipeline arguments. The tracking code generated by this processor may also include cart content entry depending on whether the ADCRequestData object contains one of the following events:

• atg.commerce.order.ItemAddedToOrder
• atg.commerce.order.ItemQuantityChanged
• atg.commerce.order.ItemRemovedFromOrder
• atg.commerce.promotion.ScenarioAddedItemToOrder
• atg.dps.Login
• atg.commerce.fulfillment.SubmitOrder
• atg.commerce.pricing.PriceChanged
These events notify TrackingCodeProcessor that cart content or order's price may have changed so new cart content tracking information should be sent to Recommendations On Demand service. The TrackingCodeProcessor processor extends ADC's ADCEventPipelineProcessor and serves as a base class for the all other clickstream tracking code related processors (for product, category pages, search result pages, etc.)

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.0/Recommendations/src/atg/projects/store/recommendations/processor/TrackingCodeProcessor.java#1 $Change: 630322 $

Author:

Yekaterina Kostenevich

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CART_ENTRY
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CUSTOMER_ID_ENTRY
static int	DEFAULT_TIMEOUT Default failover timeout
static java.lang.String	DISABLED_FAILOVER
static java.lang.String	EXCLUDE_DEFAULT_STORE_ENTRY
static java.lang.String	FAILOVER_CONTENT
static java.lang.String	FAILOVER_ENTRY
static java.lang.String	FAILOVER_SKIP_RECOMMENDATIONS
static java.lang.String	FAILOVER_TIMEOUT_ENTRY
static java.lang.String	INCLUDE_PRICE_ENTRY
static java.lang.String	LOCALE_ENTRY
static java.lang.String	PERFORM_MONITOR_NAME
static java.lang.String	PERFORM_OPERATION_NAME
static java.lang.String	PRODUCT_ENTRY
static java.lang.String	RETAILER_ID_ENTRY
static java.lang.String	STORE_ID_ENTRY
static java.lang.String	TRACKING_DIV Entries format constants
static java.lang.String	VIEW_ENTRY

Fields inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

sResourceBundle

Fields inherited from class atg.adc.pipeline.ADCPipelineProcessor

MADE_CHANGE, NO_CHANGE

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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
TrackingCodeProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendEntry(java.lang.StringBuilder pTrackingCodeContent, java.lang.String pEntry) The utility method that appends entry to the StringBuilder in the case if it's not null or empty.
protected java.lang.String	buildCartEntry(atg.adc.pipeline.ADCPipelineArgs pArgs, atg.commerce.order.Order pOrder) Builds 'cart' entry for the recommendations clickstream tracking code.
java.lang.String	buildCustomerIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds customerId entry for the recommendations clickstream tracking code.
protected java.lang.String	buildExcludeDefaultStoreEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds 'excludeDefaultStore' parameter entry for the recommendations clickstream tracking code.
protected java.lang.String	buildFailoverEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds failover configuration entry.
protected java.lang.String	buildIncludePriceEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds '-inc-price' entry for the recommendations clickstream tracking code.
protected java.lang.String	buildLocaleEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds 'locale' entry for the recommendations clickstream tracking code.
java.lang.String	buildRetailerIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds retailer ID entry for recommendations tracking code.
protected java.lang.String	buildStoreIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds storeId entry for the recommendations clickstream tracking code.
protected java.lang.String	buildTrackingCode(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds recommendations tracking code markup to be appended to the ADC data.
protected java.lang.String	buildTrackingCodeContent(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds the content of tracking code DIV element.
protected java.lang.String	buildTrackingCodeViewContent(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds the content of the recommendations 'view' configuration parameter that will be put inside of the tracking code view entry.
protected java.lang.String	buildTrackingCodeViewEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds view entry for the recommendations clickstream tracking code.
protected atg.commerce.order.Order	getCurrentOrder(atg.adc.pipeline.ADCPipelineArgs pArgs) The method gets Order object corresponding to the current user's shopping cart.
int	getFailoverTimeout() Gets the failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.
atg.commerce.pricing.priceLists.PriceListManager	getPriceListManager() Gets the price list manager
java.lang.String	getRetailerId() Gets the Retailer Id provided by Recommendations On Demand service
java.lang.String	getShoppingCartPath() Gets path to shopping cart Nucleus component
boolean	isEnableFailover() Returns the boolean indicating whether Recommendations failover should be disabled.
boolean	isExcludeDefaultStore() Returns ecludeDefaultStore, that represents the value of excludeDefaultStore parameter for clickstream tracking code.
protected boolean	isIncludeCartContent(atg.adc.pipeline.ADCPipelineArgs pArgs) This method checks whether ADCRequestData contains one of the events listed in the JMSTypes property.
boolean	isIncludeLocale() Returns the boolean indicating whether 'locale' entry should be included into tracking code.
boolean	isIncludePrice() Returns the boolean indicating whether 'include price' entry should be included into tracking code.
boolean	isSkipRecommendations() Returns the boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.
boolean	isUseContentFailover() Returns the boolean indicating whether the content included into the recommendations container should be displayed as failover content.
protected int	processADCData(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds and appends tracking code to the response stream.
int	processEvent(atg.adc.pipeline.ADCPipelineArgs pArgs, javax.jms.Message pMessage) Do nothing.
void	setEnableFailover(boolean pEnableFailover) Sets the boolean indicating whether Recommendations failover should be disabled.
void	setExcludeDefaultStore(boolean pExcludeDefaultStore) Sets ecludeDefaultStore, that represents the value of excludeDefaultStore parameter for clickstream tracking code.
void	setFailoverTimeout(int pFailoverTimeout) Sets the failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.
void	setIncludeLocale(boolean pIncludeLocale) Sets includeLocale, that indicates whether 'locale' entry should be included into tracking code.
void	setIncludePrice(boolean pIncludePrice) Sets includePrice, that indicates whether 'include price' entry should be included into tracking code.
void	setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager) Sets the price list manager
void	setRetailerId(java.lang.String pRetailerId) Sets Retailer Id provided by Recommendations On Demand service
void	setShoppingCartPath(java.lang.String pShoppingCartPath) Sets Get path to shopping cart Nucleus component
void	setSkipRecommendations(boolean pSkipRecommendations) Sets the boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.
void	setUseContentFailover(boolean pUseContentFailover) Sets the boolean indicating whether the content included into the recommendations container should be displayed as failover content.
int	updateADCData(atg.adc.pipeline.ADCPipelineArgs pArgs) If the ADC request data stored in pipeline arguments contains all required data the method builds recommendations clickstream tracking code and appends it to the current auto-tagging data in stored in the ADC request data that later will be inserted into response output stream.
protected boolean	validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs) The method checks whether the ADC data stored in pipeline arguments contains all required information for the processor.

Methods inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

getJMSTypes, getObjectFromMessage, processEvents, setJMSTypes

Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor

getRetCodes, isEnabled, runProcess, setEnabled

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

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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

TRACKING_DIV

public static final java.lang.String TRACKING_DIV

Entries format constants

See Also:

Constant Field Values

CUSTOMER_ID_ENTRY

public static final java.lang.String CUSTOMER_ID_ENTRY

See Also:

Constant Field Values

RETAILER_ID_ENTRY

public static final java.lang.String RETAILER_ID_ENTRY

See Also:

Constant Field Values

STORE_ID_ENTRY

public static final java.lang.String STORE_ID_ENTRY

See Also:

Constant Field Values

VIEW_ENTRY

public static final java.lang.String VIEW_ENTRY

See Also:

Constant Field Values

EXCLUDE_DEFAULT_STORE_ENTRY

public static final java.lang.String EXCLUDE_DEFAULT_STORE_ENTRY

See Also:

Constant Field Values

PRODUCT_ENTRY

public static final java.lang.String PRODUCT_ENTRY

See Also:

Constant Field Values

CART_ENTRY

public static final java.lang.String CART_ENTRY

See Also:

Constant Field Values

INCLUDE_PRICE_ENTRY

public static final java.lang.String INCLUDE_PRICE_ENTRY

See Also:

Constant Field Values

LOCALE_ENTRY

public static final java.lang.String LOCALE_ENTRY

See Also:

Constant Field Values

FAILOVER_ENTRY

public static final java.lang.String FAILOVER_ENTRY

See Also:

Constant Field Values

DISABLED_FAILOVER

public static final java.lang.String DISABLED_FAILOVER

See Also:

Constant Field Values

FAILOVER_TIMEOUT_ENTRY

public static final java.lang.String FAILOVER_TIMEOUT_ENTRY

See Also:

Constant Field Values

FAILOVER_SKIP_RECOMMENDATIONS

public static final java.lang.String FAILOVER_SKIP_RECOMMENDATIONS

See Also:

Constant Field Values

FAILOVER_CONTENT

public static final java.lang.String FAILOVER_CONTENT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Default failover timeout

See Also:

Constant Field Values

PERFORM_MONITOR_NAME

public static final java.lang.String PERFORM_MONITOR_NAME

See Also:

Constant Field Values

PERFORM_OPERATION_NAME

public static final java.lang.String PERFORM_OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

TrackingCodeProcessor

public TrackingCodeProcessor()

Method Detail

getPriceListManager

public atg.commerce.pricing.priceLists.PriceListManager getPriceListManager()

Gets the price list manager

Returns:

the price list manager

setPriceListManager

public void setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)

Sets the price list manager

Parameters:

pPriceListManager - the price list manager

isIncludeLocale

public boolean isIncludeLocale()

Returns the boolean indicating whether 'locale' entry should be included into tracking code.

Returns:

the includeLocale the boolean indicating whether 'locale' entry should be included into tracking code.

setIncludeLocale

public void setIncludeLocale(boolean pIncludeLocale)

Sets includeLocale, that indicates whether 'locale' entry should be included into tracking code.

Parameters:

pIncludeLocale - the includeLocale to set

isIncludePrice

public boolean isIncludePrice()

Returns the boolean indicating whether 'include price' entry should be included into tracking code.

Returns:

the boolean indicating whether 'include price' entry should be included into tracking code.

setIncludePrice

public void setIncludePrice(boolean pIncludePrice)

Sets includePrice, that indicates whether 'include price' entry should be included into tracking code.

Parameters:

pIncludePrice - the includePrice to set

getShoppingCartPath

public java.lang.String getShoppingCartPath()

Gets path to shopping cart Nucleus component

Returns:

the path to shopping cart Nucleus component

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)

Sets Get path to shopping cart Nucleus component

Parameters:

pShoppingCartPath - the path to shopping cart Nucleus component

isExcludeDefaultStore

public boolean isExcludeDefaultStore()

Returns ecludeDefaultStore, that represents the value of excludeDefaultStore parameter for clickstream tracking code.

Returns:

the boolean representing the value of excludeDefaultStore parameter for clickstream tracking code.

setExcludeDefaultStore

public void setExcludeDefaultStore(boolean pExcludeDefaultStore)

Sets ecludeDefaultStore, that represents the value of excludeDefaultStore parameter for clickstream tracking code.

Parameters:

pExcludeDefaultStore - the boolean representing the value of excludeDefaultStore parameter for clickstream tracking code.

getRetailerId

public java.lang.String getRetailerId()

Gets the Retailer Id provided by Recommendations On Demand service

Returns:

the Retailer Id provided by Recommendations On Demand service

setRetailerId

public void setRetailerId(java.lang.String pRetailerId)

Sets Retailer Id provided by Recommendations On Demand service

Parameters:

pRetailerId - the Retailer Id to set

isEnableFailover

public boolean isEnableFailover()

Returns the boolean indicating whether Recommendations failover should be disabled.

Returns:

the boolean indicating whether Recommendations failover should be disabled.

setEnableFailover

public void setEnableFailover(boolean pEnableFailover)

Sets the boolean indicating whether Recommendations failover should be disabled.

Parameters:

pEnableFailover - the boolean indicating whether Recommendations failover should be disabled.

isSkipRecommendations

public boolean isSkipRecommendations()

Returns the boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.

Returns:

The boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.

setSkipRecommendations

public void setSkipRecommendations(boolean pSkipRecommendations)

Sets the boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.

Parameters:

pSkipRecommendations - The boolean indicating whether generated recommendations should be skipped and Recommendations failover content should be used instead.

isUseContentFailover

public boolean isUseContentFailover()

Returns the boolean indicating whether the content included into the recommendations container should be displayed as failover content.

Returns:

the boolean indicating whether the content included into the recommendations container should be displayed as failover content.

setUseContentFailover

public void setUseContentFailover(boolean pUseContentFailover)

Sets the boolean indicating whether the content included into the recommendations container should be displayed as failover content.

Parameters:

pUseContentFailover - the boolean indicating whether the content included into the recommendations container should be displayed as failover content.

getFailoverTimeout

public int getFailoverTimeout()

Gets the failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.

Returns:

The failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.

setFailoverTimeout

public void setFailoverTimeout(int pFailoverTimeout)

Sets the failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.

Parameters:

pFailoverTimeout - the failover timeout in milliseconds indicating how long to wait for generated recommendations before using the failover.

updateADCData

public int updateADCData(atg.adc.pipeline.ADCPipelineArgs pArgs)

If the ADC request data stored in pipeline arguments contains all required data the method builds recommendations clickstream tracking code and appends it to the current auto-tagging data in stored in the ADC request data that later will be inserted into response output stream.

Overrides:

updateADCData in class atg.adc.pipeline.ADCEventPipelineProcessor

Parameters:

pArgs - The pipeline arguments

Returns:

status code NO_CHANGE

validateRequiredData

protected boolean validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs)

The method checks whether the ADC data stored in pipeline arguments contains all required information for the processor. In this case there is no any specific data that should be added to ADC data before processor invocation.

Parameters:

pArgs - The pipeline arguments

Returns:

true

processADCData

protected int processADCData(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds and appends tracking code to the response stream.

Parameters:

pArgs - The pipeline arguments

Returns:

status code MADE_CHANGE

buildTrackingCode

protected java.lang.String buildTrackingCode(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds recommendations tracking code markup to be appended to the ADC data.

Parameters:

pArgs - ADC pipeline arguments

Returns:

recommendations tracking code markup.

buildTrackingCodeContent

protected java.lang.String buildTrackingCodeContent(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds the content of tracking code DIV element.

Parameters:

pArgs - ADC pipeline arguments

Returns:

the content for the tracking code DIV element.

appendEntry

protected void appendEntry(java.lang.StringBuilder pTrackingCodeContent,
               java.lang.String pEntry)

The utility method that appends entry to the StringBuilder in the case if it's not null or empty.

Parameters:

pTrackingCodeContent - trackingCodeContent StringBuilder object

pEntry - the entry to append to trackingCodeContent

buildTrackingCodeViewEntry

protected java.lang.String buildTrackingCodeViewEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds view entry for the recommendations clickstream tracking code. The entry is built by calling the buildTrackingCodeViewContent() and inserting the result into 'view' entry container markup.

Parameters:

pArgs - ADC pipeline arguments

Returns:

'view' entry for the recommendations clickstream tracking code

buildTrackingCodeViewContent

protected java.lang.String buildTrackingCodeViewContent(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds the content of the recommendations 'view' configuration parameter that will be put inside of the tracking code view entry. The content can consist of different set of parameters so the method will call the sequence of build functions for each particular entry that should be included into recommendations view configuration parameter. For this processor the buildStoreIdEntry() and buildExcludeDefaultStoreEntry() will be called.

Parameters:

pArgs - ADC pipeline arguments

Returns:

content of the recommendations 'view' configuration parameter

buildRetailerIdEntry

public java.lang.String buildRetailerIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds retailer ID entry for recommendations tracking code.

Parameters:

pArgs - ADC pipeline arguments

Returns:

retailer ID entry.

buildCustomerIdEntry

public java.lang.String buildCustomerIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds customerId entry for the recommendations clickstream tracking code. Retrieves customer ID from Profile component. If profile is transient no entry is built.

Parameters:

pArgs - ADC pipeline arguments

Returns:

customer ID entry.

buildStoreIdEntry

protected java.lang.String buildStoreIdEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds storeId entry for the recommendations clickstream tracking code. The current site ID is obtained by calling SiteContextManager.getCurrentSiteId() method. If the application is run in no multisite context no entry will be created.

Parameters:

pArgs - ADC pipeline arguments

Returns:

store ID entry.

buildLocaleEntry

protected java.lang.String buildLocaleEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds 'locale' entry for the recommendations clickstream tracking code. The locale is taken from configured in the current site configuration's or profile sale price list or, if sale price list is null, from list price list.

Parameters:

pArgs - ADC pipeline arguments

Returns:

the 'locale' entry

buildIncludePriceEntry

protected java.lang.String buildIncludePriceEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds '-inc-price' entry for the recommendations clickstream tracking code.

Parameters:

pArgs - ADC pipeline arguments

Returns:

the include price entry

buildExcludeDefaultStoreEntry

protected java.lang.String buildExcludeDefaultStoreEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds 'excludeDefaultStore' parameter entry for the recommendations clickstream tracking code. The value of 'excludeDefaultStore' parameter is configurable through processor's configuration.

Parameters:

pArgs - ADC pipeline arguments

Returns:

excludeDefaultStore parameter entry

buildFailoverEntry

protected java.lang.String buildFailoverEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds failover configuration entry. If configuration doesn't differ from Recommendations On Demand default failover configuration no content is returned for failover entry.

Parameters:

pArgs - ADC pipeline arguments

Returns:

failover configuration entry

buildCartEntry

protected java.lang.String buildCartEntry(atg.adc.pipeline.ADCPipelineArgs pArgs,
                              atg.commerce.order.Order pOrder)

Builds 'cart' entry for the recommendations clickstream tracking code. The method iterates through the order's commerce items and adds product ID for each commerce item to the 'cart' element of the tracking code. The empty cart content is also included to let ATG Recommendations service know that the cart is empty.

Parameters:

pArgs - ADC pipeline arguments

pOrder - current shopping cart

Returns:

cart entry

getCurrentOrder

protected atg.commerce.order.Order getCurrentOrder(atg.adc.pipeline.ADCPipelineArgs pArgs)

The method gets Order object corresponding to the current user's shopping cart. The path to the ShoppingCart component is configurable using the processor's configuration. The order returned by this method will be passed to the buildCartEntry() method for further processing.

Parameters:

pArgs - ADC pipeline arguments

Returns:

order object corresponding to the current user's shopping cart

isIncludeCartContent

protected boolean isIncludeCartContent(atg.adc.pipeline.ADCPipelineArgs pArgs)

This method checks whether ADCRequestData contains one of the events listed in the JMSTypes property.

Parameters:

pArgs - ADC pipeline arguments

Returns:

true - if ADCRequestData contains one of the events listed in the JMSTypes property. False otherwise.

processEvent

public int processEvent(atg.adc.pipeline.ADCPipelineArgs pArgs,
               javax.jms.Message pMessage)

Do nothing. Always return NO_CHANGE.

Specified by:

processEvent in class atg.adc.pipeline.ADCEventPipelineProcessor

Parameters:

pArgs - The ADCPipelineArgs for this pipeline execution

pMessage - A JMS message that matches one of the types in the JMSTypes property.

Returns:

NO_CHANGE