org.ametys.workspaces.repository.maintenance

Class AbstractMaintenanceTask

java.lang.Object

org.ametys.workspaces.repository.maintenance.AbstractMaintenanceTask

All Implemented Interfaces:

LogEnabled

Direct Known Subclasses:

ConsistencyCheckTask, DataStoreGarbageCollectorTask, ReindexingTask

public abstract class AbstractMaintenanceTask
extends Object
implements LogEnabled

Jackrabbit maintenance tasks implementations should extends this class.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_isFinished
protected Logger	_logger Logger for traces
protected TaskProgress	_progress TaskProgress
protected RepositoryConfig	_repositoryConfig The repository config
protected RepositoryProvider	_repositoryProvider The repository provider.

Constructor Summary

Constructors

Constructor and Description
AbstractMaintenanceTask()

Method Summary

Modifier and Type	Method and Description
protected String	_getFormattedDuration(long elapsedTime) Transforms millisecond to a formatted string representing a duration.
protected abstract void	apply() Apply the tasks (within the execute method()).
protected void	close() Close the tasks
void	execute(RepositoryConfig repositoryConfig) Execute the task
Map<String,Object>	getProgressInfo() Get progress information.
protected void	initialize() Initialize the tasks.
boolean	isFinished() Is the execution of the task finished?
private void	setFinished()
private void	setInErrorState(Exception e)
protected abstract void	setLogger() Set the tasks logger.
void	setLogger(Logger logger) Called at creation time to provide a Logger.
private void	setRunning()

Methods inherited from class java.lang.Object

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

Field Detail

_progress

protected TaskProgress _progress

TaskProgress

_repositoryConfig

protected RepositoryConfig _repositoryConfig

The repository config

_repositoryProvider

protected RepositoryProvider _repositoryProvider

The repository provider.

_logger

protected Logger _logger

Logger for traces

_isFinished

private boolean _isFinished

Constructor Detail

AbstractMaintenanceTask

public AbstractMaintenanceTask()

Method Detail

execute

public void execute(RepositoryConfig repositoryConfig)
             throws RepositoryException

Execute the task

Parameters:

repositoryConfig - The RepositoryConfig object, used to create new Repository instance.

Throws:

RepositoryException - If an error with the repository occurs while the task is executed.

initialize

protected void initialize()
                   throws RepositoryException

Initialize the tasks. This method can also create the TaskProgress object bounded to the task.

Throws:

RepositoryException - If a repository exception

setLogger

protected abstract void setLogger()

Set the tasks logger.

setLogger

public void setLogger(Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

apply

protected abstract void apply()
                       throws RepositoryException

Apply the tasks (within the execute method()).

Throws:

RepositoryException - If a repository exception

close

protected void close()
              throws RepositoryException

Close the tasks

Throws:

RepositoryException - If a repository exception

getProgressInfo

public Map<String,Object> getProgressInfo()

Get progress information.

Returns:

a map containing information on the progress status.

isFinished

public boolean isFinished()

Is the execution of the task finished?

Returns:

true if finished

setRunning

private void setRunning()

setFinished

private void setFinished()

setInErrorState

private void setInErrorState(Exception e)

_getFormattedDuration

protected String _getFormattedDuration(long elapsedTime)

Transforms millisecond to a formatted string representing a duration.

Parameters:

elapsedTime - milleseconds corresponding to the duration.

Returns:

Pretty formatted string.