atg.purge.pipeline.processor
Class RepositoryItemPurgeProcessor

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.purge.pipeline.processor.RepositoryItemPurgeProcessor

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, ProcessorConstants, PipelineProcessor, java.util.EventListener

public class RepositoryItemPurgeProcessor
extends GenericService
implements PipelineProcessor, ProcessorConstants

Pipeline processor implementation for purging current item through repository API

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.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

RepositoryItemPurgeProcessor()

Method Summary

void	doStartService() Ensure the repository and item descriptor name are set before starting.
java.lang.String	getItemDescriptorName() Returns item descriptor name
MutableRepository	getRepository() Returns property Repository
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method runs the actual processor and does the work.
void	setItemDescriptorName(java.lang.String pItemDescriptorName) Sets item descriptor name
void	setRepository(MutableRepository pRepository) Sets property Repository

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

RepositoryItemPurgeProcessor

public RepositoryItemPurgeProcessor()

Method Detail

setRepository

public void setRepository(MutableRepository pRepository)

Sets property Repository

getRepository

public MutableRepository getRepository()

Returns property Repository

getItemDescriptorName

public java.lang.String getItemDescriptorName()

Returns item descriptor name

Returns:

item descriptor name

setItemDescriptorName

public void setItemDescriptorName(java.lang.String pItemDescriptorName)

Sets item descriptor name

Parameters:

pItemDescriptorName - item descriptor name

getRetCodes

public int[] getRetCodes()

Description copied from interface: PipelineProcessor

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Description copied from interface: PipelineProcessor

This method runs the actual processor and does the work. pParam is user data and pResult is an object which contains result data. The return value of the method is what determines what the next link to be executed is.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

pResult - 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

doStartService

public void doStartService()
                    throws ServiceException

Ensure the repository and item descriptor name are set before starting.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up