atg.commerce.endeca.cache
Class DimensionValueCacheDroplet

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.commerce.endeca.cache.DimensionValueCacheDroplet

All Implemented Interfaces:

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

public class DimensionValueCacheDroplet
extends DynamoServlet

A droplet used to query the DimensionValueCache from a page. Accepts a repository id and will return the DimensionValueCacheEntry for that particular id in the cache.

Input Parameters

repositoryId: The repository id used as a key in the cache.

ancestors: An optional parameter. Either a List or a String of ancestors delimited by a colon. If no ancestors are specified then the default ancestor path is taken.

Open Parameters

output: Rendered when the assembler returned content.

empty: Rendered when the assembler returned no content.

error: Rendered when an error occurred. Log files can be used to determine the nature of the error.

Output Parameters

dimensionValueCacheEntry: The requested value from the cache

Field Summary

static java.lang.String	ANCESTOR_LIST Optional parameter
static java.lang.String	CACHE_ENTRY
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	EMPTY
static java.lang.String	ERROR
static java.lang.String	OUTPUT
static java.lang.String	REPOSITORY_ID

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

DimensionValueCacheDroplet()

Method Summary

DimensionValueCacheTools	getDimensionValueCacheTools()
java.lang.String	getRepositoryIdDelim()
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Accepts a repositoryId input parameter.
void	setDimensionValueCacheTools(DimensionValueCacheTools pDimensionValueCacheTools)
void	setRepositoryIdDelim(java.lang.String pRepositoryIdDelim)

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, 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 java.lang.String CLASS_VERSION

Class version string

REPOSITORY_ID

public static final java.lang.String REPOSITORY_ID

See Also:

Constant Field Values

ANCESTOR_LIST

public static final java.lang.String ANCESTOR_LIST

Optional parameter

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

See Also:

Constant Field Values

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

EMPTY

public static final java.lang.String EMPTY

See Also:

Constant Field Values

CACHE_ENTRY

public static final java.lang.String CACHE_ENTRY

See Also:

Constant Field Values

Constructor Detail

DimensionValueCacheDroplet

public DimensionValueCacheDroplet()

Method Detail

getDimensionValueCacheTools

public DimensionValueCacheTools getDimensionValueCacheTools()

Returns:

the mDimensionValueCacheTools. A tools class containing useful and reusable methods.

setDimensionValueCacheTools

public void setDimensionValueCacheTools(DimensionValueCacheTools pDimensionValueCacheTools)

Parameters:

mDimensionValueCacheTools - the mDimensionValueCacheTools to set

getRepositoryIdDelim

public java.lang.String getRepositoryIdDelim()

Returns:

the mRepositoryIdDelim. The delimited used to split repository ids when passed in from a page in string form. E.g "id0001:id0002:id0003". Defaults to a colon.

setRepositoryIdDelim

public void setRepositoryIdDelim(java.lang.String pRepositoryIdDelim)

Parameters:

mRepositoryIdDelim - the mRepositoryIdDelim to set

service

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

Accepts a repositoryId input parameter. Uses this repository id to retrieve an entry in the DimensionValueCache and makes this entry available via a dimensionValueCacheEntry page parameter within the output open parameter.

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.