atg.adc.pipeline
Class CheckForNoInsertProcessor

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.pipeline.ADCPipelineProcessor
              atg.adc.pipeline.CheckForNoInsertProcessor

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, PipelineProcessor, java.util.EventListener

public class CheckForNoInsertProcessor
extends ADCPipelineProcessor

This class checks if the current request data has been marked "noInsertForThisPage". If this property is true, then the processor will return STOP_CHAIN_EXECUTION. Otherwise, CONTINUE is returned.

See Also:

atg.adc.ADCRequestData#isNoInsertForThisPage

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static int	CONTINUE

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

CheckForNoInsertProcessor()

Method Summary

int[]	getRetCodes() ADCPipelineProcessors can return three things: STOP_CHAIN_EXECUTION - stop immediately NO_CHANGE - didn't do anything MADE_CHANGE - did some work
int	updateADCData(ADCPipelineArgs pArgs) If ADCRequestData.noInsertForThisPage is true, return STOP_CHAIN_EXECUTION, otherwise return CONTINUE

Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor

isEnabled, runProcess, setEnabled

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CONTINUE

public static final int CONTINUE

See Also:

Constant Field Values

Constructor Detail

CheckForNoInsertProcessor

public CheckForNoInsertProcessor()

Method Detail

getRetCodes

public int[] getRetCodes()

Description copied from class: ADCPipelineProcessor

ADCPipelineProcessors can return three things: STOP_CHAIN_EXECUTION - stop immediately NO_CHANGE - didn't do anything MADE_CHANGE - did some work

Specified by:

getRetCodes in interface PipelineProcessor

Overrides:

getRetCodes in class ADCPipelineProcessor

Returns:

{ STOP_CHAIN_EXECUTION, CONTINUE }

updateADCData

public int updateADCData(ADCPipelineArgs pArgs)

If ADCRequestData.noInsertForThisPage is true, return STOP_CHAIN_EXECUTION, otherwise return CONTINUE

Specified by:

updateADCData in class ADCPipelineProcessor

Parameters:

pArgs - The pipeline processor

Returns:

STOP_CHAIN_EXECUTION or CONTINUE