public class ContentRequestURLDroplet
extends atg.svc.droplet.FrameworkUrlDroplet
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.
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
|
DYNAMIC_INCLUDES, EMPTY, NS, OUTPUT, PANEL_STACKS, PANELS, SELECT_TABBED_PANELS, splitChar, TAB, URL
Constructor and Description |
---|
ContentRequestURLDroplet() |
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) |
getDynamicIncludes, getNextSteps, getPanels, getPanelStacks, getSelectTabbedPanels, getSplitChar, getTab, getUrl, getURL, setDynamicIncludes, setNextSteps, setPanels, setPanelStacks, setSelectTabbedPanels, setSplitChar, setTab, setUrl, setURL
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final java.lang.String CLASS_VERSION
public static final atg.nucleus.naming.ParameterName NAVIGATION_ACTION
public static final atg.nucleus.naming.ParameterName DIMENSION_ID
public static final atg.nucleus.naming.ParameterName CONTENT_PATH
public static final atg.nucleus.naming.ParameterName RECORD_OFFSET
public static final atg.nucleus.naming.ParameterName RECORDS_PER_PAGE
protected Configuration mConfiguration
protected java.lang.String mContentURIParamName
protected java.lang.String mSearchResultPageURL
public Configuration getConfiguration()
public void setConfiguration(Configuration pConfiguration)
public java.lang.String getContentURIParamName()
public void setContentURIParamName(java.lang.String pContentURIParamName)
public java.lang.String getSearchResultPageURL()
public void setSearchResultPageURL(java.lang.String pSearchResultPageURL)
public void service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
searchResultPageURL
when one isn't provided
as input to the droplet call.service
in class atg.svc.droplet.FrameworkUrlDroplet
javax.servlet.ServletException
java.io.IOException
protected void addExtraParameters(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse, java.util.Map<java.lang.String,java.lang.String> pExtraParameters)
addExtraParameters
in class atg.svc.droplet.FrameworkUrlDroplet
protected java.lang.String determineContentURI(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- pResponse
- determineContentURIFromDimensionId(String, DynamoHttpServletRequest, DynamoHttpServletResponse)
,
determineContentURIFromNavigationAction(NavigationAction, DynamoHttpServletRequest, DynamoHttpServletResponse)
protected java.lang.String determineContentURIFromNavigationAction(com.endeca.infront.cartridge.model.NavigationAction pNavigationAction, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pNavigationAction
- pRequest
- pResponse
- protected java.lang.String determineContentURIFromDimensionId(java.lang.String pDimensionId, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pDimensionId
- pRequest
- pResponse
-