Package org.ametys.workspaces.repository.maintenance

Class MaintenanceTaskManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.workspaces.repository.maintenance.MaintenanceTaskManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

MaintenanceTaskManager

public class MaintenanceTaskManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

The MaintenanceTaskManager Component

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MaintenanceTaskManager.MaintenanceTaskType	Task types

Field Summary

Fields

Modifier and Type	Field	Description
protected static MaintenanceTaskManager.MaintenanceTaskType	_lastRunningTaskType	The maintenance running task
protected RepositoryProvider	_repositoryProvider	The repository provider.
protected static AbstractMaintenanceTask	_runningTask	The maintenance running task
protected MaintenanceTaskManager.MaintenanceTaskType	_runningTaskType	The maintenance running task type
protected SystemStatus	_systemStatus	System status provider
static final String	MAINTENANCE_TASK_ENDED	The maintenance task ended system status
static final String	MAINTENANCE_TASK_RUNNING	The maintenance task running system status
static final String	REPOSITORY_UNAVAILABLE	The repository unavailable system status
static final String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
MaintenanceTaskManager()

Method Summary

Modifier and Type	Method	Description
protected RepositoryConfig	_createRepositoryConfig()	Create a repository config
protected AbstractMaintenanceTask	_createTask(MaintenanceTaskManager.MaintenanceTaskType type)	Initialize the tasks.
protected Pair<RepositoryConfig,RepositoryContext>	_getRepositoryInfo()	Retrieve the repository config if no repository is available or the repository context of the available repository
void	contextualize(Context context)
String	getLastRunningTaskType()	Retrieves the type of the previous running task, if no task is currently running.
Map<String,Object>	getProgressInfo()	Get progress information.
String	getRunningTaskType()	Retrieves the type of the running task
boolean	isRepositoryStarted()	Indicates is the Ametys repository is started or has been shut down.
boolean	isTaskRunning()	Indicates if a maintenance task is running.
boolean	launch(MaintenanceTaskManager.MaintenanceTaskType type)	Launch a maintenance task
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role.

REPOSITORY_UNAVAILABLE

public static final String REPOSITORY_UNAVAILABLE

The repository unavailable system status

See Also:

• Constant Field Values

MAINTENANCE_TASK_RUNNING

public static final String MAINTENANCE_TASK_RUNNING

The maintenance task running system status

See Also:

• Constant Field Values

MAINTENANCE_TASK_ENDED

public static final String MAINTENANCE_TASK_ENDED

The maintenance task ended system status

See Also:

• Constant Field Values

_runningTask

protected static AbstractMaintenanceTask _runningTask

The maintenance running task

_lastRunningTaskType

protected static MaintenanceTaskManager.MaintenanceTaskType _lastRunningTaskType

The maintenance running task

_runningTaskType

protected MaintenanceTaskManager.MaintenanceTaskType _runningTaskType

The maintenance running task type

_systemStatus

protected SystemStatus _systemStatus

System status provider

_repositoryProvider

protected RepositoryProvider _repositoryProvider

The repository provider.

Constructor Details

MaintenanceTaskManager

public MaintenanceTaskManager()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

launch

public boolean launch(MaintenanceTaskManager.MaintenanceTaskType type)
               throws Exception

Launch a maintenance task

Parameters:

type - The maintenance task type

Returns:

true if a task has been launched

Throws:

Exception - when an error occurred

_getRepositoryInfo

protected Pair<RepositoryConfig,RepositoryContext> _getRepositoryInfo()
                                                               throws ConfigurationException,
javax.jcr.UnsupportedRepositoryOperationException

Retrieve the repository config if no repository is available or the repository context of the available repository

Returns:

Either the config or the context depending if the repository is available. The other one will be null.

Throws:

ConfigurationException - if an error occurred while generating the config

javax.jcr.UnsupportedRepositoryOperationException - if the repository doesn't support retrieving the context

_createRepositoryConfig

protected RepositoryConfig _createRepositoryConfig()
                                            throws ConfigurationException

Create a repository config

Returns:

the repository config

Throws:

ConfigurationException - if an error occurred

_createTask

protected AbstractMaintenanceTask _createTask(MaintenanceTaskManager.MaintenanceTaskType type)

Initialize the tasks.

Parameters:

type - MaintenanceTaskType

Returns:

the task.

isTaskRunning

public boolean isTaskRunning()

Indicates if a maintenance task is running.

Returns:

true if a task is running.

getProgressInfo

public Map<String,Object> getProgressInfo()

Get progress information.

Returns:

a map containing information on the progress status.

getRunningTaskType

public String getRunningTaskType()

Retrieves the type of the running task

Returns:

the type of the running task or null.

getLastRunningTaskType

public String getLastRunningTaskType()

Retrieves the type of the previous running task, if no task is currently running. Otherwise, the current task type will be return.

Returns:

the type or null

isRepositoryStarted

public boolean isRepositoryStarted()

Indicates is the Ametys repository is started or has been shut down.

Returns:

true is the repository is started