|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.service.collections.filter.droplet.CollectionFilter
public class CollectionFilter
This droplet is used to execute collection filters.
The filter can be configured or provided as a parameter.
The consultCache and updateCache values can be configured or provided as a parameter.
If a key parameter is not provided, the consultCache and updateCache values are ignored and false is used.
Input parameters:
Output parameters:
Oparams:
Configurable values
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ParameterName |
COLLECTION_PARAM
the parameter name for the collection parameter |
static ParameterName |
CONSULTCACHE_PARAM
the parameter name for the consultCache parameter |
static java.lang.String |
EMPTY_OPARAM
the name for the empty oparam |
static java.lang.String |
ERROR_MSG_OUTPARAM
the name for the errorMsg output parameter |
static java.lang.String |
ERROR_OPARAM
the name for the error oparam |
static ParameterName |
FILTER_PARAM
the parameter name for the filter parameter |
static java.lang.String |
FILTERED_COLLECTION_OUTPARAM
the name for the filtered collection output parameter |
static ParameterName |
KEY_PARAM
the parameter name for the key parameter |
protected java.lang.Boolean |
mConsultCache
|
protected CachedCollectionFilter |
mFilter
|
protected java.lang.Boolean |
mUpdateCache
|
static java.lang.String |
OUTPUT_OPARAM
the name for the output oparam |
static ParameterName |
PROFILE_PARAM
the parameter name for the profile parameter |
static ParameterName |
UPDATECACHE_PARAM
the parameter name for the updateCache parameter |
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 | |
---|---|
CollectionFilter()
|
Method Summary | |
---|---|
protected java.util.Collection |
getCollection(DynamoHttpServletRequest pRequest)
|
java.lang.Boolean |
getConsultCache()
|
protected boolean |
getConsultCache(DynamoHttpServletRequest pRequest)
|
java.util.List |
getExtraParameterNames()
|
protected java.util.Map |
getExtraParameters(DynamoHttpServletRequest pRequest)
This method iterates through the list of extra parameter names |
CachedCollectionFilter |
getFilter()
|
protected CachedCollectionFilter |
getFilter(DynamoHttpServletRequest pRequest)
|
protected java.lang.String |
getKey(DynamoHttpServletRequest pRequest)
|
protected RepositoryItem |
getProfile(DynamoHttpServletRequest pRequest)
|
java.lang.Boolean |
getUpdateCache()
|
protected boolean |
getUpdateCache(DynamoHttpServletRequest req)
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Executes the filter. |
void |
setConsultCache(java.lang.Boolean pConsultCache)
Sets the default value for consultCache. |
void |
setExtraParameterNames(java.util.List pExtraParameterNames)
Sets the list with extra parameter names |
void |
setFilter(CachedCollectionFilter pFilter)
Sets the the default filter to execute |
void |
setUpdateCache(java.lang.Boolean pUpdateCache)
Sets the default value for updateCache. |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName COLLECTION_PARAM
public static final ParameterName PROFILE_PARAM
public static final ParameterName FILTER_PARAM
public static final ParameterName KEY_PARAM
public static final ParameterName CONSULTCACHE_PARAM
public static final ParameterName UPDATECACHE_PARAM
public static final java.lang.String ERROR_MSG_OUTPARAM
public static final java.lang.String FILTERED_COLLECTION_OUTPARAM
public static final java.lang.String ERROR_OPARAM
public static final java.lang.String OUTPUT_OPARAM
public static final java.lang.String EMPTY_OPARAM
protected CachedCollectionFilter mFilter
protected java.lang.Boolean mUpdateCache
protected java.lang.Boolean mConsultCache
Constructor Detail |
---|
public CollectionFilter()
Method Detail |
---|
public void setFilter(CachedCollectionFilter pFilter)
public CachedCollectionFilter getFilter()
public java.lang.Boolean getUpdateCache()
public void setUpdateCache(java.lang.Boolean pUpdateCache)
public java.util.List getExtraParameterNames()
public void setExtraParameterNames(java.util.List pExtraParameterNames)
public java.lang.Boolean getConsultCache()
public void setConsultCache(java.lang.Boolean pConsultCache)
protected RepositoryItem getProfile(DynamoHttpServletRequest pRequest) throws FilterException
FilterException
protected CachedCollectionFilter getFilter(DynamoHttpServletRequest pRequest) throws FilterException
FilterException
protected java.lang.String getKey(DynamoHttpServletRequest pRequest) throws FilterException
FilterException
protected java.util.Collection getCollection(DynamoHttpServletRequest pRequest) throws FilterException
FilterException
protected boolean getConsultCache(DynamoHttpServletRequest pRequest) throws FilterException
FilterException
protected boolean getUpdateCache(DynamoHttpServletRequest req) throws FilterException
FilterException
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
If a key is not provided, the consultCache and updateCache flags are forced to false.
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this request
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.protected java.util.Map getExtraParameters(DynamoHttpServletRequest pRequest)
pExtraParameterNames
- the list of preconfigured extra parameter namespRequest
- Dynamo http request
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |