atg.commerce.adc.processor

Class ProcSetCategory

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.adc.pipeline.ADCPipelineProcessor

atg.adc.pipeline.PatternMappingProcessor

atg.adc.pipeline.SetCategoryProcessor

atg.commerce.adc.processor.ProcSetCategory

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, PipelineProcessor, java.util.EventListener

public class ProcSetCategory
extends atg.adc.pipeline.SetCategoryProcessor

This processor will determine the product category and page categoory that will be stored in the ADCRequestData for use in the remaining pipeline processors. If the url of the requested page matches an entry in the configured categoryPages property, the product category is taken from a query parameter named in the categoryIdQueryArgs property. The page category is determined by atg.adc.pipeline.SetCategorProcessor. If the request page includes the <adc:setProductCategory category="something"/> tag, then that value is always used instead.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.adc.pipeline.SetCategoryProcessor

CATEGORY_ID, CATEGORY_NAME

Fields inherited from class atg.adc.pipeline.ADCPipelineProcessor

MADE_CHANGE, NO_CHANGE

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	findProductCategory(ADCPipelineArgs pArgs) TODO Look up the category template by iterating down the request uri.
int	updateADCData(ADCPipelineArgs pArgs) Store the product category in the ADCRequestData.

Methods inherited from class atg.adc.pipeline.SetCategoryProcessor

doStartService, findCategory, findCategoryId, findQueryArgument, getCategoryIdQueryArgs, getCategoryPagePatterns, getCategoryPages, getCategoryPagesCache, getDefaultCategory, getPageCategories, getPageCategoryCache, getPageCategoryPatternMappings, pathMatchesPattern, setCategoryIdQueryArgs, setCategoryPagePatterns, setCategoryPages, setCategoryPagesCache, setDefaultCategory, setPageCategories, setPageCategoryCache, setPageCategoryPatternMappings

Methods inherited from class atg.adc.pipeline.PatternMappingProcessor

createPatternMappings, findMappingForPath

Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor

getRetCodes, isEnabled, runProcess, setEnabled

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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, 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

Constructor Detail

ProcSetCategory

public ProcSetCategory()

Method Detail

findProductCategory

protected java.lang.String findProductCategory(ADCPipelineArgs pArgs)

TODO Look up the category template by iterating down the request uri.

Parameters:

pArgs - The pipeline args

Returns:

The category

updateADCData

public int updateADCData(ADCPipelineArgs pArgs)

Store the product category in the ADCRequestData. If the page includes the <adc:setProductCategory category="something"/> tag, then that value is used. Otherwise, the categoryIdQueryArgs are searched for.

Overrides:

updateADCData in class atg.adc.pipeline.SetCategoryProcessor

Parameters:

The - pipeline args

Returns:

NO_CHANGE