atg.adc.pipeline
Class ADCPipelineProcessor
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.adc.pipeline.ADCPipelineProcessor
- 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, PipelineProcessor, java.util.EventListener
- Direct Known Subclasses:
- AppendStringProcessor, AssignmentProcessor, CheckForNoInsertProcessor, ExtraTagsProcessor, SimulationProcessor
public abstract class ADCPipelineProcessor
- extends GenericService
- implements PipelineProcessor
The ADCPipelineProcessor is used to implement each of the processors
used in an ADC pipeline. Basically this means the parameter to the
runProcess
method is expected to be an instance of
ADCPipelineArgs
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
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 |
boolean |
isEnabled()
|
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This assumes that pParam is an instance of ADCPipelineArgs
It will get the arguments and call updateADCData with the result |
void |
setEnabled(boolean pEnabled)
Boolean indicating if the given processor should execute |
abstract int |
updateADCData(ADCPipelineArgs pArgs)
This is where each subclass does its work. |
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 |
CLASS_VERSION
public static final java.lang.String CLASS_VERSION
- Class version string
- See Also:
- Constant Field Values
NO_CHANGE
public static final int NO_CHANGE
- See Also:
- Constant Field Values
MADE_CHANGE
public static final int MADE_CHANGE
- See Also:
- Constant Field Values
ADCPipelineProcessor
public ADCPipelineProcessor()
getRetCodes
public int[] getRetCodes()
- 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
- Returns:
- an array of all the return codes that could be returned by this PipelineProcessor.
setEnabled
public void setEnabled(boolean pEnabled)
- Boolean indicating if the given processor should execute
- Parameters:
pEnabled
- Boolean indicating if the given processor should execute
isEnabled
public boolean isEnabled()
- Returns:
- Boolean indicating if the given processor should execute
runProcess
public int runProcess(java.lang.Object pParam,
PipelineResult pResult)
throws java.lang.Exception
- This assumes that pParam is an instance of ADCPipelineArgs
It will get the arguments and call updateADCData with the result
- Specified by:
runProcess
in interface PipelineProcessor
- Parameters:
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other data
- Returns:
- an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION
will notify the PipelineManager to stop execution. An unmapped value will throw a
RunProcessException.
- Throws:
java.lang.Exception
updateADCData
public abstract int updateADCData(ADCPipelineArgs pArgs)
- This is where each subclass does its work. If changes are made
return MADE_CHANGE. If nothing happens, return NO_CHANGE.
- Parameters:
pArgs
- The arguments class that will be modified