atg.commerce.csr.catalog.endeca

Class CSRInvokeAssembler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.endeca.assembler.droplet.InvokeAssembler

atg.commerce.csr.catalog.endeca.CSRInvokeAssembler

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.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class CSRInvokeAssembler
extends atg.endeca.assembler.droplet.InvokeAssembler

Extends the core behavior of the droplet to provide additional output parameters and other functionality needed for the CSC integration with Endeca.

• Updates the last URI cache. The cache value is used in cases where the droplet is invoked with a contentURI (e.g. includePath param)
• Determines the appropriate URI to use when none is provided. This will either be the last cached URI or the default URI
• Wraps the request to provide the navigation state parameters to Endeca.
• Parses the result from Endeca into a Map of ContentItems keyed by type.

NOTE: The logic to set the current session profile's thread local datasource to reference the active customer is now performed in atg.userprofiling.endeca.assembler.ProfileInvokeAssemblerCallbackImpl and is invoked from AssemblerTools.

See Also:

AssemblerTools.getCallbacks(), atg.userprofiling.endeca.assembler.ProfileInvokeAssemblerCallbackImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CONTENT_ITEM_MAP The output parameter that references the Map> of ContentItems keyed by their type
protected atg.svc.agent.environment.EnvironmentTools	mEnvironmentTools

Fields inherited from class atg.endeca.assembler.droplet.InvokeAssembler

CONTENT_COLLECTION, CONTENT_ITEM_PARAM, CONTENT_ITEM_TYPE, ERROR_KEY, ERROR_OPARAM, INCLUDE_PATH, NAVIGATION_ACTION_CONTENT_PATH, OUTPUT_OPARAM, RECORD_ACTION_CONTENT_PATH, RULE_LIMIT

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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

Method Summary

Modifier and Type	Method and Description
atg.svc.agent.environment.EnvironmentTools	getEnvironmentTools() A reference to the EnvironmentTools component used to resolve a reference to the active customer profile.
protected com.endeca.infront.assembler.ContentItem	invokeAssembler(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse, com.endeca.infront.assembler.ContentItem pContentItem) Extends the core behavior to parse the results into a Map of ContentItems and provide that Map as an output parameter.
protected java.util.Map	parseContentByType(com.endeca.infront.assembler.ContentItem pContentItem) Iterates over the results and parses out all ContentItems by type.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Extends the base behavior to first set the session profile's thread local datasource to the active customer before calling the super implementation.
void	setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)

Methods inherited from class atg.endeca.assembler.droplet.InvokeAssembler

createContentInclude, createContentSlotConfig, getAssemblerTools, setAssemblerTools

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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

CONTENT_ITEM_MAP

public static final java.lang.String CONTENT_ITEM_MAP

The output parameter that references the Map> of ContentItems keyed by their type

See Also:

Constant Field Values

mEnvironmentTools

protected atg.svc.agent.environment.EnvironmentTools mEnvironmentTools

Constructor Detail

CSRInvokeAssembler

public CSRInvokeAssembler()

Method Detail

getEnvironmentTools

public atg.svc.agent.environment.EnvironmentTools getEnvironmentTools()

A reference to the EnvironmentTools component used to resolve a reference to the active customer profile.

Returns:

setEnvironmentTools

public void setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Extends the base behavior to first set the session profile's thread local datasource to the active customer before calling the super implementation.

Overrides:

service in class atg.endeca.assembler.droplet.InvokeAssembler

Throws:

javax.servlet.ServletException

java.io.IOException

invokeAssembler

protected com.endeca.infront.assembler.ContentItem invokeAssembler(atg.servlet.DynamoHttpServletRequest pRequest,
                                                                   atg.servlet.DynamoHttpServletResponse pResponse,
                                                                   com.endeca.infront.assembler.ContentItem pContentItem)
                                                            throws com.endeca.infront.assembler.AssemblerException

Extends the core behavior to parse the results into a Map of ContentItems and provide that Map as an output parameter.

Overrides:

invokeAssembler in class atg.endeca.assembler.droplet.InvokeAssembler

Throws:

com.endeca.infront.assembler.AssemblerException

parseContentByType

protected java.util.Map parseContentByType(com.endeca.infront.assembler.ContentItem pContentItem)

Iterates over the results and parses out all ContentItems by type. The result is a Map> where the key is the type and the value is a List of ContentItems matching that type.

Parameters:

pContentItem -

Returns:

Map