atg.commerce.csr.catalog.endeca

Class ContentRequestURLDroplet

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.svc.droplet.FrameworkUrlDroplet

atg.commerce.csr.catalog.endeca.ContentRequestURLDroplet

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 ContentRequestURLDroplet
extends atg.svc.droplet.FrameworkUrlDroplet

This extension creates framework urls for Endeca catalog guided navigation.

The framework url, if not provided as an input parameter, will default to the configured search result page.

The droplet will added a content URI query parameter to the URL using the configurable parameter name. The content URI is used to query Endeca for the results. The content URI can be provided directly as an input parameter, or it can be generated from an Endeca NavigationAction object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static atg.nucleus.naming.ParameterName	CONTENT_PATH The input param name for specifying a value to use as the contentURI
static atg.nucleus.naming.ParameterName	DIMENSION_ID The input param name for specifying a dimension Id
protected Configuration	mConfiguration
protected java.lang.String	mContentURIParamName
protected java.lang.String	mSearchResultPageURL
static atg.nucleus.naming.ParameterName	NAVIGATION_ACTION The input param name for specifying an Endeca NavigationAction object
static atg.nucleus.naming.ParameterName	RECORD_OFFSET The input param name for specifying a record offset
static atg.nucleus.naming.ParameterName	RECORDS_PER_PAGE The input param name for specifying a record offset

Fields inherited from class atg.svc.droplet.FrameworkUrlDroplet

DYNAMIC_INCLUDES, EMPTY, NS, OUTPUT, PANEL_STACKS, PANELS, SELECT_TABBED_PANELS, splitChar, TAB, URL

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

Method Summary

Modifier and Type	Method and Description
protected void	addExtraParameters(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse, java.util.Map<java.lang.String,java.lang.String> pExtraParameters) Adds the contentURI parameter to the extra parameters.
protected java.lang.String	determineContentURI(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Determines the contentURI value based on the incoming parmeters.
protected java.lang.String	determineContentURIFromDimensionId(java.lang.String pDimensionId, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates the contentURI value from the defaultContentURI and the provided dimension value
protected java.lang.String	determineContentURIFromNavigationAction(com.endeca.infront.cartridge.model.NavigationAction pNavigationAction, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Creates a content URI from the given NavigationAction, by concatenating its navigationState and contentPath property values.
Configuration	getConfiguration()
java.lang.String	getContentURIParamName()
java.lang.String	getSearchResultPageURL()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Sets the input URL parameter based on the configured searchResultPageURL when one isn't provided as input to the droplet call.
void	setConfiguration(Configuration pConfiguration)
void	setContentURIParamName(java.lang.String pContentURIParamName)
void	setSearchResultPageURL(java.lang.String pSearchResultPageURL)

Methods inherited from class atg.svc.droplet.FrameworkUrlDroplet

getDynamicIncludes, getNextSteps, getPanels, getPanelStacks, getSelectTabbedPanels, getSplitChar, getTab, getUrl, getURL, setDynamicIncludes, setNextSteps, setPanels, setPanelStacks, setSelectTabbedPanels, setSplitChar, setTab, setUrl, setURL

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

NAVIGATION_ACTION

public static final atg.nucleus.naming.ParameterName NAVIGATION_ACTION

The input param name for specifying an Endeca NavigationAction object

DIMENSION_ID

public static final atg.nucleus.naming.ParameterName DIMENSION_ID

The input param name for specifying a dimension Id

CONTENT_PATH

public static final atg.nucleus.naming.ParameterName CONTENT_PATH

The input param name for specifying a value to use as the contentURI

RECORD_OFFSET

public static final atg.nucleus.naming.ParameterName RECORD_OFFSET

The input param name for specifying a record offset

RECORDS_PER_PAGE

public static final atg.nucleus.naming.ParameterName RECORDS_PER_PAGE

The input param name for specifying a record offset

mConfiguration

protected Configuration mConfiguration

mContentURIParamName

protected java.lang.String mContentURIParamName

mSearchResultPageURL

protected java.lang.String mSearchResultPageURL

Constructor Detail

ContentRequestURLDroplet

public ContentRequestURLDroplet()

Method Detail

getConfiguration

public Configuration getConfiguration()

setConfiguration

public void setConfiguration(Configuration pConfiguration)

getContentURIParamName

public java.lang.String getContentURIParamName()

setContentURIParamName

public void setContentURIParamName(java.lang.String pContentURIParamName)

getSearchResultPageURL

public java.lang.String getSearchResultPageURL()

setSearchResultPageURL

public void setSearchResultPageURL(java.lang.String pSearchResultPageURL)

service

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

Sets the input URL parameter based on the configured searchResultPageURL when one isn't provided as input to the droplet call.

Overrides:

service in class atg.svc.droplet.FrameworkUrlDroplet

Throws:

javax.servlet.ServletException

java.io.IOException

addExtraParameters

protected void addExtraParameters(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse pResponse,
                                  java.util.Map<java.lang.String,java.lang.String> pExtraParameters)

Adds the contentURI parameter to the extra parameters. This will cause it to be included as a parameter on the generated URL

Overrides:

addExtraParameters in class atg.svc.droplet.FrameworkUrlDroplet

determineContentURI

protected java.lang.String determineContentURI(atg.servlet.DynamoHttpServletRequest pRequest,
                                               atg.servlet.DynamoHttpServletResponse pResponse)

Determines the contentURI value based on the incoming parmeters.

Parameters:

pRequest -

pResponse -

Returns:

the value of the contentURI parameter

See Also:

determineContentURIFromDimensionId(String, DynamoHttpServletRequest, DynamoHttpServletResponse), determineContentURIFromNavigationAction(NavigationAction, DynamoHttpServletRequest, DynamoHttpServletResponse)

determineContentURIFromNavigationAction

protected java.lang.String determineContentURIFromNavigationAction(com.endeca.infront.cartridge.model.NavigationAction pNavigationAction,
                                                                   atg.servlet.DynamoHttpServletRequest pRequest,
                                                                   atg.servlet.DynamoHttpServletResponse pResponse)

Creates a content URI from the given NavigationAction, by concatenating its navigationState and contentPath property values.

Parameters:

pNavigationAction -

pRequest -

pResponse -

determineContentURIFromDimensionId

protected java.lang.String determineContentURIFromDimensionId(java.lang.String pDimensionId,
                                                              atg.servlet.DynamoHttpServletRequest pRequest,
                                                              atg.servlet.DynamoHttpServletResponse pResponse)

Creates the contentURI value from the defaultContentURI and the provided dimension value

Parameters:

pDimensionId -

pRequest -

pResponse -