atg.purge
Class PurgeService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.scheduler.SchedulableService
              atg.service.scheduler.SingletonSchedulableService
                  atg.purge.PurgeService

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

public class PurgeService
extends SingletonSchedulableService

Purge service class extends SingletonSchedulableService to allow multiple Dynamo servers to run the same scheduled purge task, while guaranteeing that only one instance of the service will perform the scheduled purge task at any time. Purge task is defined with purge producer and purge configuration properties.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.service.scheduler.SchedulableService

mJobId

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

PurgeService()

Method Summary

void	doScheduledTask(Scheduler pScheduler, ScheduledJob pJob) Perform the scheduled purge task for this service.
void	doStartService() Ensure that all required properties are set
PurgeConfiguration	getPurgeConfiguration() Returns purge configuration
PurgeProducer	getPurgeProducer() Returns purge producer
void	setPurgeConfiguration(PurgeConfiguration pPurgeConfiguration) Sets property purgeConfiguration
void	setPurgeProducer(PurgeProducer pPurgeProducer) Sets property purgeProducer

Methods inherited from class atg.service.scheduler.SingletonSchedulableService

acquireLock, getClientLockManager, getLockName, getLockTimeOut, performScheduledTask, releaseLock, setClientLockManager, setLockName, setLockTimeOut

Methods inherited from class atg.service.scheduler.SchedulableService

doStopService, getJobDescription, getJobId, getJobName, getSchedule, getScheduler, getThreadMethod, getThreadMethodString, isTransactional, setJobDescription, setJobName, setSchedule, setScheduler, setThreadMethod, setThreadMethodString, setTransactional, startScheduledJob, stopScheduledJob

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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

PurgeService

public PurgeService()

Method Detail

getPurgeProducer

public PurgeProducer getPurgeProducer()

Returns purge producer

Returns:

the purge producer

setPurgeProducer

public void setPurgeProducer(PurgeProducer pPurgeProducer)

Sets property purgeProducer

Parameters:

pPurgeProducer - the purge producer

getPurgeConfiguration

public PurgeConfiguration getPurgeConfiguration()

Returns purge configuration

Returns:

the purge configuration

setPurgeConfiguration

public void setPurgeConfiguration(PurgeConfiguration pPurgeConfiguration)

Sets property purgeConfiguration

Parameters:

pPurgeConfiguration - the purge configuration

doScheduledTask

public void doScheduledTask(Scheduler pScheduler,
                            ScheduledJob pJob)

Perform the scheduled purge task for this service.

Specified by:

doScheduledTask in class SingletonSchedulableService

doStartService

public void doStartService()
                    throws ServiceException

Ensure that all required properties are set

Overrides:

doStartService in class SchedulableService

Throws:

ServiceException - if an error occurred during the operation