atg.purge.handler
Class PipelinePurgeHandler

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.purge.handler.PipelinePurgeHandler
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, atg.purge.handler.PurgeHandler, ProcessorConstants, java.util.EventListener

public class PipelinePurgeHandler
extends GenericService
implements atg.purge.handler.PurgeHandler, ProcessorConstants

Purge handler implementation which start new pipeline chain and pass current purge item as a parameter into it.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.purge.pipeline.ProcessorConstants
PURGE_ITEM, RETCODE_NOT_OK, RETCODE_OK
 
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
PipelinePurgeHandler()
           
 
Method Summary
 void doStartService()
          Ensure the pipeline manager and chain id are set before starting.
 java.lang.String getPipelineChainId()
          Gets the id of the pipeline chain to execute.
 PipelineManager getPipelineManager()
          Gets the pipeline manager component.
 void handlePurgeItem(PurgeItem pItem)
          Execute the pipeline chain passing current purge item as pipeline parameter.
 void setPipelineChainId(java.lang.String pPipelineChainId)
          Sets the id of the pipeline chain to execute.
 void setPipelineManager(PipelineManager pPipelineManager)
          Sets the pipeline manager component.
 
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
 
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
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

PipelinePurgeHandler

public PipelinePurgeHandler()
Method Detail

setPipelineManager

public void setPipelineManager(PipelineManager pPipelineManager)
Sets the pipeline manager component.


getPipelineManager

public PipelineManager getPipelineManager()
Gets the pipeline manager component.


setPipelineChainId

public void setPipelineChainId(java.lang.String pPipelineChainId)
Sets the id of the pipeline chain to execute.


getPipelineChainId

public java.lang.String getPipelineChainId()
Gets the id of the pipeline chain to execute.


handlePurgeItem

public void handlePurgeItem(PurgeItem pItem)
                     throws atg.purge.PurgeException
Execute the pipeline chain passing current purge item as pipeline parameter.

Specified by:
handlePurgeItem in interface atg.purge.handler.PurgeHandler
Parameters:
pItem - the purge item
Throws:
atg.purge.PurgeException - if an error occurred while purging current item.

doStartService

public void doStartService()
                    throws ServiceException
Ensure the pipeline manager and chain id are set before starting.

Overrides:
doStartService in class GenericService
Throws:
ServiceException - if the Service had a problem starting up