public class PurgeProducer
extends atg.repository.PagedQueryIteratorFactory
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
PurgeProducer() |
Modifier and Type | Method and Description |
---|---|
atg.repository.PagedQueryIterator |
createPagedQueryIterator(PurgeConfiguration pPurgeConfiguration)
Create a new PagedQueryIterator, using property values set on this factory and purge configuration.
|
protected PurgeItem |
createPurgeItem(RepositoryItem pRepositoryItem,
PurgeConfiguration pPurgeConfiguration)
Construct purge item object based on current repository item and purge configuration
|
atg.purge.PurgeSummary |
createPurgeSummary(PurgeConfiguration pPurgeConfiguration)
Create purge summary results based on purge configuration
|
void |
doStartService()
Ensure that all required properties are set
|
ProcessConfiguration |
getProcessConfiguration()
Returns property
processConfiguration |
PurgeConfiguration |
getPurgeConfiguration()
Returns property
purgeConfiguration |
PurgeExecutor |
getPurgeExecutor()
Returns property
purgeExecutor |
atg.purge.PurgeProgressTools |
getPurgeProgressTools()
Returns property
purgeProgressTools |
boolean |
isPurgeRunning()
Returns true if purge is currently running or hanging and false otherwise.
|
void |
performTask()
Start purge process work using current purge configuration in a new thread so that we
are not blocking method execution until purge completed.
|
void |
performTask(PurgeConfiguration pPurgeConfiguration)
Start purge process work using selected purge configuration in a new thread so that we
are not blocking method execution until purge completed.
|
void |
performTaskAndWait()
Start purge process work using current purge configuration.
|
void |
performTaskAndWait(PurgeConfiguration pPurgeConfiguration)
Start purge process work using selected purge configuration.
|
void |
setProcessConfiguration(ProcessConfiguration pProcessConfiguration)
Sets property
processConfiguration |
void |
setPurgeConfiguration(PurgeConfiguration pPurgeConfiguration)
Sets property
purgeConfiguration |
void |
setPurgeExecutor(PurgeExecutor pPurgeExecutor)
Sets property
purgeExecutor |
void |
setPurgeProgressTools(atg.purge.PurgeProgressTools pPurgeProgressTools)
Sets property
purgeProgressTools |
void |
startPurge()
Start purge process work using current purge configuration.
|
void |
startPurge(PurgeConfiguration pPurgeConfiguration)
Start purge process work using selected purge configuration.
|
countItems, countItemsUsingInnerClass, createPagedQueryIterator, getBaseQuery, getItemDescriptorName, getPageSize, getPagingPropertyName, getQueryOptions, getRepository, getRepositoryItemGroup, getRepositoryView, getTransactionManager, setBaseQuery, setItemDescriptorName, setPageSize, setPagingPropertyName, setQueryOptions, setRepository, setRepositoryItemGroup, setRepositoryView, setTransactionManager
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, toString
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public PurgeExecutor getPurgeExecutor()
purgeExecutor
public void setPurgeExecutor(PurgeExecutor pPurgeExecutor)
purgeExecutor
pPurgeExecutor
- the purge executorpublic PurgeConfiguration getPurgeConfiguration()
purgeConfiguration
public void setPurgeConfiguration(PurgeConfiguration pPurgeConfiguration)
purgeConfiguration
pPurgeConfiguration
- the purge configurationpublic ProcessConfiguration getProcessConfiguration()
processConfiguration
public void setProcessConfiguration(ProcessConfiguration pProcessConfiguration)
processConfiguration
pProcessConfiguration
- the process configurationpublic atg.purge.PurgeProgressTools getPurgeProgressTools()
purgeProgressTools
public void setPurgeProgressTools(atg.purge.PurgeProgressTools pPurgeProgressTools)
purgeProgressTools
pPurgeProgressTools
- the purge progress tools to work with purge progress repositorypublic void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic boolean isPurgeRunning()
public void startPurge() throws java.lang.Exception
java.lang.Exception
- if there is an errorpublic void startPurge(PurgeConfiguration pPurgeConfiguration) throws java.lang.Exception
pPurgeConfiguration
- the purge configurationjava.lang.Exception
- if there is an errorpublic void performTask()
public void performTask(PurgeConfiguration pPurgeConfiguration)
pPurgeConfiguration
- the purge configurationpublic void performTaskAndWait()
public void performTaskAndWait(PurgeConfiguration pPurgeConfiguration)
pPurgeConfiguration
- the purge configurationpublic atg.purge.PurgeSummary createPurgeSummary(PurgeConfiguration pPurgeConfiguration) throws RepositoryException
pPurgeConfiguration
- the purge configurationRepositoryException
- if there is an error while performing
the query operationpublic atg.repository.PagedQueryIterator createPagedQueryIterator(PurgeConfiguration pPurgeConfiguration) throws RepositoryException
pPurgeConfiguration
- the purge configurationRepositoryException
- if there is an error while performing
the query operationprotected PurgeItem createPurgeItem(RepositoryItem pRepositoryItem, PurgeConfiguration pPurgeConfiguration)
pRepositoryItem
- the repository itempPurgeConfiguration
- the purge configuration