PurgingService (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService
  - - atg.service.scheduler.SchedulableService
    - - atg.epub.purge.PurgingService

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.deployment.common.event.TopologyChangeEventListener, atg.epub.purge.PurgeEventSender, 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.service.lockmanager.LockOwnershipListener, Schedulable, java.util.EventListener
```
public class PurgingService
extends SchedulableService
implements atg.epub.purge.PurgeEventSender, atg.service.lockmanager.LockOwnershipListener, atg.deployment.common.event.TopologyChangeEventListener
```
Versioning performance degrades as more and more versions are added to the system. At some point in time, assets are no longer required and can be removed from the system, which will lead to improved performance of various versioning operations. This service which can be configured to purge versions periodically or on demand. Use the property maxAgeDays to configure the expiration time for versions. Note that the time is considered inclusive eg. assets which were checked in *on* or before the maxAgeDays will be purged.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION`
`static java.lang.String`	`ERR_CURRENT_DEPLOYMENT_FOUND`
`static java.lang.String`	`ERR_CURRENT_SNAPSHOT_NULL`
`static java.lang.String`	`ERR_NO_DEPLOYMENT_SERVER`
`static java.lang.String`	`ERR_NO_VERSION_MANAGER` resource keys *
`static java.lang.String`	`ERR_SNAPSHOT_IN_PURGE_RANGE`
`static java.lang.String`	`ERR_SOLID_NOT_SUPPORTED`
`static java.lang.Object`	`sSummaryGenerationMutex` Mutex used for request thread and summary generation threads to synchronize.

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

Constructors
Constructor and Description

PurgingService()
Empty constructor

Constructors
Constructor and Description
`PurgingService()` Empty constructor

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`acquireLock(long pLockTimeout, java.io.Serializable pLockKey, boolean pWriteLock)` The method will attempt to acqure an exclusive write lock.
`void`	`addPurgeEventListener(PurgeEventListener pListener)` Adds the listener.
`protected javax.servlet.Servlet`	`createAdminServlet()` Creates and returns a new Servlet that will administer this service.
`void`	`doStartService()` The default implementation is to just start our scheduled job.
`atg.epub.purge.PurgeResultSummary`	`execute(long pDays, boolean pDryRun)`
`protected atg.epub.purge.ProjectPurgeResultSummary`	`executeProcessPurge(java.sql.Timestamp pCutOffTime, boolean pDryRun)`
`protected atg.epub.purge.VersionPurgeResultSummary`	`executeWorkspacePurge(java.sql.Timestamp pCutOff, boolean pDryRun)`
`void`	`firePurgeEvent(PurgeEvent pEvent)` Fire purge events to listeners.
`static java.lang.String`	`formatMsg(java.lang.String pMsgKey, java.lang.Object[] pArgs)` get message resource
`java.lang.String`	`getAssetEditLockName()` Get the name of the global asset edit lock
`long`	`getAssetEditLockTimeOut()` Get the maximum time we wait for a lock, in milliseconds.
`int`	`getCachedReportDisplayCount()`
`ClientLockManager`	`getClientLockManager()` Get the ClientLockManager used to ensure that only one instance of the service is running at any given time.
`PublishingConfiguration`	`getConfiguration()`
`atg.epub.purge.Prevalidation[]`	`getDefaultPrevalidations()`
`java.lang.String`	`getDeploymentQueueLockName()` Get the name of the deployment queue lock
`long`	`getDeploymentQueueLockTimeOut()` Get the maximum time we wait for a lock, in milliseconds.
`int`	`getMaxAgeDays()` Get property `maxAgeDays`.
`int`	`getMaxAgeDaysDecrement()` Get property `maxAgeDaysDecrement`.
`atg.epub.purge.Prevalidation[]`	`getNonDefaultPrevalidations()`
`PurgeEventListener[]`	`getPurgeEventListeners()` Returns an array of the list of PurgeEventListener.
`java.lang.String`	`getPurgingServiceLockName()` Get the name of the lock for this service.
`long`	`getPurgingServiceLockTimeOut()` Get the maximum time we wait for a lock, in milliseconds.
`java.lang.String`	`getServiceInfo()` Returns the a descriptive string about this service
`Cache`	`getSummaryReportCache()`
`javax.transaction.TransactionManager`	`getTransactionManager()` Get TransactionManager used by this service
`protected void`	`giveUpLockOwnership(java.io.Serializable pLockKey)` This method will release the lock, using the `ClientLockManager`
`protected boolean`	`isBranchInUse(Branch pBranch)` Check to see if the given branch is on use by a target.
`boolean`	`isPreciseSummaryReports()`
`boolean`	`isRoundPurgeCutoffToPreviousMidnight()`
`protected boolean`	`isSkipBranchPurge(Branch pBranch)` Check to see if the branch should be left alone
`protected boolean`	`isSkipBranchRemove(Branch pBranch)` Extend this method if you'd like some branches to be spared from removal.
`void`	`logDebug(java.lang.String pMessage)` Logs an debug event with the specified message
`void`	`logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)` Logs an debug event with the specified message and Throwable
`void`	`logDebug(java.lang.Throwable pThrowable)` Logs an debug event with the specified Throwable
`void`	`performScheduledTask(Scheduler pScheduler, ScheduledJob pJob)` The method will be called by the scheduler according to its schedule.
`void`	`readOwnershipReleased(java.lang.Object pKey)`
`protected void`	`releaseLock(java.io.Serializable pLockKey, boolean pWriteLock, boolean pKeepProcessOwnership)` This method will release the lock, using the `ClientLockManager`
`protected void`	`removeProcess(Process pProcess, ProcessHome pProcessHome, ProjectHome pProjectHome)` Removes the project and its associate process
`void`	`removePurgeEventListener(PurgeEventListener pListener)` Removes the listener.
`java.util.Map`	`removeUnusedDeploymentBranches(boolean pDryRun)` Remove branches no longer used by any target in deployment topology
`protected atg.epub.purge.PrevalidationResult[]`	`runPrePurgeValidation(java.sql.Timestamp pCutOff)`
`void`	`setAssetEditLockName(java.lang.String pAssetEditLockName)` Set the name of the global asset edit lock
`void`	`setAssetEditLockTimeOut(long pAssetEditLockTimeOut)` Set the maximum time we wait for a lock, in milliseconds.
`void`	`setCachedReportDisplayCount(int pCachedReportDisplayCount)`
`void`	`setClientLockManager(ClientLockManager pClientLockManager)` Set the ClientLockManager used to ensure that only one instance of the service is running at any given time.
`void`	`setConfiguration(PublishingConfiguration pConfiguration)` Set the publishing configuration object
`void`	`setDeploymentQueueLockName(java.lang.String pDeploymentQueueLockName)` Set the name of the deployment queue lock
`void`	`setDeploymentQueueLockTimeOut(long pDeploymentQueueLockTimeOut)` Set the maximum time we wait for a lock, in milliseconds.
`void`	`setMaxAgeDays(int pMaxAgeDays)` Set property `maxBranchAgeDays`
`void`	`setMaxAgeDaysDecrement(int pMaxAgeDaysDecrement)` Set property `Decrement`
`void`	`setNonDefaultPrevalidations(atg.epub.purge.Prevalidation[] pNonDefaultPrevalidations)`
`void`	`setPreciseSummaryReports(boolean pPreciseSummaryReports)`
`void`	`setPurgingServiceLockName(java.lang.String pPurgingServiceLockName)` Get the name of the lock for this service.
`void`	`setPurgingServiceLockTimeOut(long pPurgingServiceLockTimeOut)` Set the maximum time we wait for a lock, in milliseconds.
`void`	`setRoundPurgeCutoffToPreviousMidnight(boolean pRoundPurgeCutoffToPreviousMidnight)`
`void`	`setSummaryReportCache(Cache pSummaryReportCache)`
`void`	`topologyChanged()` When a topology changes we may have deletes a target which becomes a candidate for branch removal and our cache is invalid.
`void`	`writeOwnershipReleased(java.lang.Object pKey)` Flush cache when a purge happens on remote server.

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, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, 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
```
  - sSummaryGenerationMutex
```
public static java.lang.Object sSummaryGenerationMutex
```
    Mutex used for request thread and summary generation threads to synchronize.
  - ERR_NO_VERSION_MANAGER
```
public static final java.lang.String ERR_NO_VERSION_MANAGER
```
    resource keys *
    
    See Also:
    Constant Field Values
  - ERR_CURRENT_DEPLOYMENT_FOUND
```
public static final java.lang.String ERR_CURRENT_DEPLOYMENT_FOUND
```
    See Also:
    Constant Field Values
  - ERR_CURRENT_SNAPSHOT_NULL
```
public static final java.lang.String ERR_CURRENT_SNAPSHOT_NULL
```
    See Also:
    Constant Field Values
  - ERR_NO_DEPLOYMENT_SERVER
```
public static final java.lang.String ERR_NO_DEPLOYMENT_SERVER
```
    See Also:
    Constant Field Values
  - ERR_SNAPSHOT_IN_PURGE_RANGE
```
public static final java.lang.String ERR_SNAPSHOT_IN_PURGE_RANGE
```
    See Also:
    Constant Field Values
  - ERR_SOLID_NOT_SUPPORTED
```
public static final java.lang.String ERR_SOLID_NOT_SUPPORTED
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PurgingService
```
public PurgingService()
```
    Empty constructor
- Method Detail
  - setMaxAgeDays
```
public void setMaxAgeDays(int pMaxAgeDays)
```
    Set property maxBranchAgeDays
    
    Parameters:
    pMaxBranchAgeDays - new value to set
  - getMaxAgeDays
```
public int getMaxAgeDays()
```
    Get property maxAgeDays.
    
    Returns:
    maxAgeDays
  - setMaxAgeDaysDecrement
```
public void setMaxAgeDaysDecrement(int pMaxAgeDaysDecrement)
```
    Set property Decrement
    
    Parameters:
    pMaxAgeDaysDecrement - new value to set
  - getMaxAgeDaysDecrement
```
public int getMaxAgeDaysDecrement()
```
    Get property maxAgeDaysDecrement.
    
    Returns:
    maxAgeDays
  - isPreciseSummaryReports
```
public boolean isPreciseSummaryReports()
```
  - setPreciseSummaryReports
```
public void setPreciseSummaryReports(boolean pPreciseSummaryReports)
```
  - getSummaryReportCache
```
public Cache getSummaryReportCache()
```
  - setSummaryReportCache
```
public void setSummaryReportCache(Cache pSummaryReportCache)
```
  - getCachedReportDisplayCount
```
public int getCachedReportDisplayCount()
```
  - setCachedReportDisplayCount
```
public void setCachedReportDisplayCount(int pCachedReportDisplayCount)
```
  - getDefaultPrevalidations
```
public atg.epub.purge.Prevalidation[] getDefaultPrevalidations()
```
  - getNonDefaultPrevalidations
```
public atg.epub.purge.Prevalidation[] getNonDefaultPrevalidations()
```
  - setNonDefaultPrevalidations
```
public void setNonDefaultPrevalidations(atg.epub.purge.Prevalidation[] pNonDefaultPrevalidations)
```
  - getConfiguration
```
public PublishingConfiguration getConfiguration()
```
    Returns:
    the publishing configuration object
  - setRoundPurgeCutoffToPreviousMidnight
```
public void setRoundPurgeCutoffToPreviousMidnight(boolean pRoundPurgeCutoffToPreviousMidnight)
```
  - isRoundPurgeCutoffToPreviousMidnight
```
public boolean isRoundPurgeCutoffToPreviousMidnight()
```
  - setConfiguration
```
public void setConfiguration(PublishingConfiguration pConfiguration)
```
    Set the publishing configuration object
    
    Parameters:
    the - publishing configuration object
  - setClientLockManager
```
public void setClientLockManager(ClientLockManager pClientLockManager)
```
    Set the ClientLockManager used to ensure that only one instance of the service is running at any given time.
  - getClientLockManager
```
public ClientLockManager getClientLockManager()
```
    Get the ClientLockManager used to ensure that only one instance of the service is running at any given time.
  - setPurgingServiceLockName
```
public void setPurgingServiceLockName(java.lang.String pPurgingServiceLockName)
```
    Get the name of the lock for this service.
  - getPurgingServiceLockName
```
public java.lang.String getPurgingServiceLockName()
```
    Get the name of the lock for this service.
  - setPurgingServiceLockTimeOut
```
public void setPurgingServiceLockTimeOut(long pPurgingServiceLockTimeOut)
```
    Set the maximum time we wait for a lock, in milliseconds.
  - getPurgingServiceLockTimeOut
```
public long getPurgingServiceLockTimeOut()
```
    Get the maximum time we wait for a lock, in milliseconds.
  - setAssetEditLockName
```
public void setAssetEditLockName(java.lang.String pAssetEditLockName)
```
    Set the name of the global asset edit lock
  - getAssetEditLockName
```
public java.lang.String getAssetEditLockName()
```
    Get the name of the global asset edit lock
  - setAssetEditLockTimeOut
```
public void setAssetEditLockTimeOut(long pAssetEditLockTimeOut)
```
    Set the maximum time we wait for a lock, in milliseconds.
  - getAssetEditLockTimeOut
```
public long getAssetEditLockTimeOut()
```
    Get the maximum time we wait for a lock, in milliseconds.
  - setDeploymentQueueLockName
```
public void setDeploymentQueueLockName(java.lang.String pDeploymentQueueLockName)
```
    Set the name of the deployment queue lock
  - getDeploymentQueueLockName
```
public java.lang.String getDeploymentQueueLockName()
```
    Get the name of the deployment queue lock
  - setDeploymentQueueLockTimeOut
```
public void setDeploymentQueueLockTimeOut(long pDeploymentQueueLockTimeOut)
```
    Set the maximum time we wait for a lock, in milliseconds.
  - getDeploymentQueueLockTimeOut
```
public long getDeploymentQueueLockTimeOut()
```
    Get the maximum time we wait for a lock, in milliseconds.
  - getPurgeEventListeners
```
public PurgeEventListener[] getPurgeEventListeners()
```
    Returns an array of the list of PurgeEventListener.
    
    Specified by:
    
    getPurgeEventListeners in interface atg.epub.purge.PurgeEventSender
  - addPurgeEventListener
```
public void addPurgeEventListener(PurgeEventListener pListener)
```
    Adds the listener.
    
    Specified by:
    
    addPurgeEventListener in interface atg.epub.purge.PurgeEventSender
    
    Parameters:
    pListener - the listener wanting to know of purge events
    See Also:
    PurgeEventListener
  - removePurgeEventListener
```
public void removePurgeEventListener(PurgeEventListener pListener)
```
    Removes the listener.
    
    Specified by:
    
    removePurgeEventListener in interface atg.epub.purge.PurgeEventSender
    
    Parameters:
    pListener - the listener wanting to know of purge events
    See Also:
    PurgeEventListener
  - doStartService
```
public void doStartService()
                    throws ServiceException
```
    Description copied from class: SchedulableService
    
    The default implementation is to just start our scheduled job. Subclasses should override this to perform any extra initialization they may require.
    
    Overrides:
    
    doStartService in class SchedulableService
    
    Throws:
    
    ServiceException - if an error occurred during the operation
    See Also:
    GenericService.doStartService()
  - acquireLock
```
protected boolean acquireLock(long pLockTimeout,
                  java.io.Serializable pLockKey,
                  boolean pWriteLock)
                       throws DeadlockException,
                              TimeExceededException
```
    The method will attempt to acqure an exclusive write lock. It tries to get a global lock named lockName from the client lock manager specified by ClientLockManager.
    If the lock is obtained this method return true; If the lock is not obtained, or is not a global lock, the method returns false.
    Note: If the client lock manager is configured with its useLockServer property set to false it means that global locking is not enabled for that lock manager. In that case, acquireLock will accept a local lock instead.
    
    Parameters:
    pString -
    pLockTimeout -
    
    Throws:
    
    TimeExceededException
    
    DeadlockException
  - releaseLock
```
protected void releaseLock(java.io.Serializable pLockKey,
               boolean pWriteLock,
               boolean pKeepProcessOwnership)
```
    This method will release the lock, using the ClientLockManager
    
    Parameters:
    pKeepProcessOwnership -
  - giveUpLockOwnership
```
protected void giveUpLockOwnership(java.io.Serializable pLockKey)
```
    This method will release the lock, using the ClientLockManager
    
    Parameters:
    pKeepProcessOwnership -
  - performScheduledTask
```
public void performScheduledTask(Scheduler pScheduler,
                        ScheduledJob pJob)
```
    The method will be called by the scheduler according to its schedule. It calls acquireLock
    If the lock is obtained this method will call doScheduledTask. If the lock is not obtained the call to doScheduledTask will be skipped. In either case, the lock will be released before this method returns by calling releaseLock
    
    Specified by:
    
    performScheduledTask in interface Schedulable
    
    Specified by:
    
    performScheduledTask in class SchedulableService
    
    Parameters:
    pScheduler - the scheduler managing this job
    pJob - the scheduled job associated with this service
  - execute
```
public atg.epub.purge.PurgeResultSummary execute(long pDays,
                                        boolean pDryRun)
                                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - runPrePurgeValidation
```
protected atg.epub.purge.PrevalidationResult[] runPrePurgeValidation(java.sql.Timestamp pCutOff)
```
    Parameters:
    pMaxAge -
    
    Throws:
    
    ValidationException
  - executeWorkspacePurge
```
protected atg.epub.purge.VersionPurgeResultSummary executeWorkspacePurge(java.sql.Timestamp pCutOff,
                                                             boolean pDryRun)
                                                                  throws VersionException
```
    Throws:
    
    VersionException
  - executeProcessPurge
```
protected atg.epub.purge.ProjectPurgeResultSummary executeProcessPurge(java.sql.Timestamp pCutOffTime,
                                                           boolean pDryRun)
                                                                throws javax.transaction.SystemException,
                                                                       java.lang.IllegalStateException,
                                                                       javax.transaction.RollbackException,
                                                                       javax.ejb.EJBException,
                                                                       javax.ejb.FinderException
```
    Throws:
    
    javax.transaction.SystemException
    
    javax.transaction.RollbackException
    
    java.lang.IllegalStateException
    
    javax.ejb.FinderException
    
    javax.ejb.EJBException
  - removeProcess
```
protected void removeProcess(Process pProcess,
                 ProcessHome pProcessHome,
                 ProjectHome pProjectHome)
```
    Removes the project and its associate process
  - removeUnusedDeploymentBranches
```
public java.util.Map removeUnusedDeploymentBranches(boolean pDryRun)
                                             throws VersionException
```
    Remove branches no longer used by any target in deployment topology
    
    Throws:
    
    VersionException
  - isBranchInUse
```
protected boolean isBranchInUse(Branch pBranch)
                         throws atg.deployment.common.DeploymentException
```
    Check to see if the given branch is on use by a target.
    
    Parameters:
    pBranch -
    
    Returns:
    
    Throws:
    
    atg.deployment.common.DeploymentException
  - getTransactionManager
```
public javax.transaction.TransactionManager getTransactionManager()
```
    Get TransactionManager used by this service
    
    Returns:
    TransactionManager
  - isSkipBranchPurge
```
protected boolean isSkipBranchPurge(Branch pBranch)
```
    Check to see if the branch should be left alone
    
    Parameters:
    pBranch -
    
    Returns:
    boolean
  - isSkipBranchRemove
```
protected boolean isSkipBranchRemove(Branch pBranch)
```
    Extend this method if you'd like some branches to be spared from removal. Note that you cannot skip a child branch and not skip its parent.
    
    Parameters:
    pBranch -
    
    Returns:
  - formatMsg
```
public static java.lang.String formatMsg(java.lang.String pMsgKey,
                         java.lang.Object[] pArgs)
```
    get message resource
  - createAdminServlet
```
protected javax.servlet.Servlet createAdminServlet()
```
    Creates and returns a new Servlet that will administer this service. By default, this creates a ServiceAdminServlet, but subclasses may create their own servlets.
    
    Overrides:
    
    createAdminServlet in class GenericService
  - logDebug
```
public void logDebug(java.lang.String pMessage,
            java.lang.Throwable pThrowable)
```
    Description copied from class: GenericService
    
    Logs an debug event with the specified message and Throwable
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
    
    Overrides:
    
    logDebug in class GenericService
  - logDebug
```
public void logDebug(java.lang.String pMessage)
```
    Description copied from class: GenericService
    
    Logs an debug event with the specified message
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
    
    Overrides:
    
    logDebug in class GenericService
  - logDebug
```
public void logDebug(java.lang.Throwable pThrowable)
```
    Description copied from class: GenericService
    
    Logs an debug event with the specified Throwable
    
    Specified by:
    
    logDebug in interface atg.core.logging.Logging
    
    Specified by:
    
    logDebug in interface ApplicationLogging
    
    Overrides:
    
    logDebug in class GenericService
  - firePurgeEvent
```
public void firePurgeEvent(PurgeEvent pEvent)
```
    Fire purge events to listeners. Handles unhandled exceptions thrown by event listeners.
    
    Specified by:
    
    firePurgeEvent in interface atg.epub.purge.PurgeEventSender
  - getServiceInfo
```
public java.lang.String getServiceInfo()
```
    Description copied from class: GenericService
    
    Returns the a descriptive string about this service
    
    Overrides:
    
    getServiceInfo in class GenericService
  - readOwnershipReleased
```
public void readOwnershipReleased(java.lang.Object pKey)
```
    Specified by:
    
    readOwnershipReleased in interface atg.service.lockmanager.LockOwnershipListener
  - writeOwnershipReleased
```
public void writeOwnershipReleased(java.lang.Object pKey)
```
    Flush cache when a purge happens on remote server.
    
    Specified by:
    
    writeOwnershipReleased in interface atg.service.lockmanager.LockOwnershipListener
  - topologyChanged
```
public void topologyChanged()
```
    When a topology changes we may have deletes a target which becomes a candidate for branch removal and our cache is invalid. NOTE: this is not valid for post 9.0 releases since we don't have target branches.
    
    Specified by:
    
    topologyChanged in interface atg.deployment.common.event.TopologyChangeEventListener

Class PurgingService

Field Summary

Fields inherited from class atg.service.scheduler.SchedulableService

Fields inherited from class atg.nucleus.GenericService

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.service.scheduler.SchedulableService

Methods inherited from class atg.nucleus.GenericService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

sSummaryGenerationMutex

ERR_NO_VERSION_MANAGER

ERR_CURRENT_DEPLOYMENT_FOUND

ERR_CURRENT_SNAPSHOT_NULL

ERR_NO_DEPLOYMENT_SERVER

ERR_SNAPSHOT_IN_PURGE_RANGE

ERR_SOLID_NOT_SUPPORTED

Constructor Detail

PurgingService

Method Detail

setMaxAgeDays

getMaxAgeDays

setMaxAgeDaysDecrement

getMaxAgeDaysDecrement

isPreciseSummaryReports

setPreciseSummaryReports

getSummaryReportCache

setSummaryReportCache

getCachedReportDisplayCount

setCachedReportDisplayCount

getDefaultPrevalidations

getNonDefaultPrevalidations

setNonDefaultPrevalidations

getConfiguration

setRoundPurgeCutoffToPreviousMidnight

isRoundPurgeCutoffToPreviousMidnight

setConfiguration

setClientLockManager

getClientLockManager

setPurgingServiceLockName

getPurgingServiceLockName

setPurgingServiceLockTimeOut

getPurgingServiceLockTimeOut

setAssetEditLockName

getAssetEditLockName

setAssetEditLockTimeOut

getAssetEditLockTimeOut

setDeploymentQueueLockName

getDeploymentQueueLockName

setDeploymentQueueLockTimeOut

getDeploymentQueueLockTimeOut

getPurgeEventListeners

addPurgeEventListener

removePurgeEventListener

doStartService

acquireLock

releaseLock

giveUpLockOwnership

performScheduledTask

execute

runPrePurgeValidation

executeWorkspacePurge

executeProcessPurge

removeProcess

removeUnusedDeploymentBranches

isBranchInUse

getTransactionManager

isSkipBranchPurge

isSkipBranchRemove

formatMsg

createAdminServlet

logDebug

logDebug

logDebug

firePurgeEvent

getServiceInfo