public abstract class ADCPipelineProcessor extends GenericService implements PipelineProcessor
runProcess
method is expected to be an instance of
ADCPipelineArgs
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static int |
MADE_CHANGE |
static int |
NO_CHANGE |
SERVICE_INFO_KEY
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ADCPipelineProcessor() |
Modifier and Type | Method and Description |
---|---|
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.
|
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final java.lang.String CLASS_VERSION
public static final int NO_CHANGE
public static final int MADE_CHANGE
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
public void setEnabled(boolean pEnabled)
pEnabled
- Boolean indicating if the given processor should executepublic boolean isEnabled()
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other datajava.lang.Exception
public abstract int updateADCData(ADCPipelineArgs pArgs)
pArgs
- The arguments class that will be modified