Package org.alfresco.repo.node.cleanup

Class AbstractNodeCleanupWorker

java.lang.Object

org.alfresco.repo.node.cleanup.AbstractNodeCleanupWorker

All Implemented Interfaces:

NodeCleanupWorker

Direct Known Subclasses:

DeletedNodeCleanupWorker

public abstract class AbstractNodeCleanupWorker
extends java.lang.Object
implements NodeCleanupWorker

Base class for Node cleaners. This class ensures calls through after having created a read-write transaction that is authenticated as system.

Since:

2.2 SP2

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field	Description
protected DbNodeServiceImpl	dbNodeService
protected JobLockService	jobLockService
protected org.apache.commons.logging.Log	logger
protected NodeDAO	nodeDAO
protected TransactionService	transactionService

Constructor Summary

Constructors

Constructor	Description
AbstractNodeCleanupWorker()	Default constructor

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	doClean()	Calls doCleanInternal() in a System-user authenticated read-write transaction.
protected abstract java.util.List<java.lang.String>	doCleanInternal()	Do the actual cleanup.
protected void	refreshLock()	Helper method to refresh the current job's lock token
void	register()
void	setDbNodeService(DbNodeServiceImpl dbNodeService)
void	setJobLockService(JobLockService jobLockService)
void	setNodeDAO(NodeDAO nodeDAO)
void	setRegistry(NodeCleanupRegistry registry)
void	setTransactionService(TransactionService transactionService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

transactionService

protected TransactionService transactionService

jobLockService

protected JobLockService jobLockService

dbNodeService

protected DbNodeServiceImpl dbNodeService

nodeDAO

protected NodeDAO nodeDAO

Constructor Detail

AbstractNodeCleanupWorker

public AbstractNodeCleanupWorker()

Default constructor

Method Detail

setRegistry

public void setRegistry(NodeCleanupRegistry registry)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setJobLockService

public void setJobLockService(JobLockService jobLockService)

setDbNodeService

public void setDbNodeService(DbNodeServiceImpl dbNodeService)

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

register

public void register()

doClean

public java.util.List<java.lang.String> doClean()

Calls doCleanInternal() in a System-user authenticated read-write transaction. This method is non-blocking but passes all second and subsequent concurrent invocations straight through.

Specified by:

doClean in interface NodeCleanupWorker

Returns:

Returns a list of informational messages.

refreshLock

protected void refreshLock()
                    throws LockAcquisitionException

Helper method to refresh the current job's lock token

Throws:

LockAcquisitionException

doCleanInternal

protected abstract java.util.List<java.lang.String> doCleanInternal()
                                                             throws java.lang.Throwable

Do the actual cleanup. Any errors are handled by this base class.

Returns:

Returns the cleanup messages.

Throws:

java.lang.Throwable