com.communote.server.core.tasks

Class TaskManagementImpl

java.lang.Object

com.communote.server.core.tasks.TaskManagementImpl

All Implemented Interfaces:

TaskManagement

@Service(value="taskManagement")
 @Transactional(propagation=REQUIRED)
public class TaskManagementImpl
extends Object
implements TaskManagement

Management class for tasks.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
TaskManagementImpl()

Method Summary

Modifier and Type	Method and Description
Long	addTask(String uniqueTaskName, boolean active, Long interval, Date nextExecutionDate, Class<? extends TaskHandler> handlerClass) Add a new task.
Long	addTask(String uniqueTaskName, boolean active, Long interval, Date nextExecutionDate, Map<String,String> properties, Class<? extends TaskHandler> handlerClass) Add a new task.
Long	addTask(String uniqueTaskName, boolean active, Long interval, Date nextExecutionDate, Map<String,String> properties, String handlerClass) Add a new task.
Long	addTask(String uniqueTaskName, boolean active, Long interval, Date nextExecutionDate, String handlerClass) Add a new task.
void	addTaskHandler(Class<? extends TaskHandler> taskHandler) Add a handler for tasks.
void	addTaskHandler(String handlerName, Class<? extends TaskHandler> taskHandler) Add a handler for tasks with the given name.
void	addTaskHandlerWithTask(String handlerName, Class<? extends TaskHandler> taskHandlerClazz, Map<String,String> properties, long startOffset, boolean resetFailed) Add a task handler and create a task for it.
void	failTaskExecution(String uniqueTaskName) Mark the execution of a task as failed.
TaskTO	findTask(String uniqueTaskName) Get the details of a task.
TaskTO	getNextScheduledTask() Return the next task to be scheduled.
TaskTO	getNextScheduledTask(Date upperBound) Return the next task to be scheduled.
Collection<TaskTO>	getNextScheduledTasks(Date upperBound, int maxTasks, Collection<Long> taskIdsToExclude) Get the tasks to schedule next
Collection<TaskExecution>	getTaskExecutions(String instanceName) Return all task executions running on the Communote with the given name.
boolean	isTaskRunningOnCurrentInstance(String uniqueTaskName) Return whether the given task is running on the current instance.
String	killTaskExecution(Long executionId) Kill the task with given execution ID by removing the execution and setting the task back to pending.
void	removeTask(String uniqueTaskName) Remove a task if it is not RUNNING.
boolean	removeTaskHandler(String handlerName) Remove the task handler class from the list of known handlers.
void	rescheduleTask(String uniqueTaskName, Date nextExecutionDate) Reschedule a pending task.
void	resetTask(String uniqueTaskName) Reset a task back from failed to pending.
Long	startTaskExecution(String uniqueTaskName) Mark a task as running on this instance by creating an execution for it and setting the status to RUNNING.
Long	startTaskExecutionTx(String uniqueTaskName) Same as TaskManagement.startTaskExecution(String) but can throw DatabaseIntegrityViolationException.
void	stopAllTaskExecutions() Calls stopAllTaskExecutions(true,now).
void	stopAllTaskExecutions(boolean resetFailed, Date rescheduleDate) End all task executions of this instance and schedules them again.
void	stopTaskExecution(String uniqueTaskName) End the execution of the given task.
void	stopTaskExecution(String uniqueTaskName, Date rescheduleDate) End the execution of the given task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskManagementImpl

public TaskManagementImpl()

Method Detail

addTask

public Long addTask(String uniqueTaskName,
                    boolean active,
                    Long interval,
                    Date nextExecutionDate,
                    Class<? extends TaskHandler> handlerClass)
             throws TaskAlreadyExistsException

Description copied from interface: TaskManagement

Add a new task.

Specified by:

addTask in interface TaskManagement

Parameters:

uniqueTaskName - Unique name for this task.

active - True, if active.

interval - Interval for the execution.

nextExecutionDate - The next execution date.

handlerClass - Class of the handler.

Returns:

The id of the Task.

Throws:

TaskAlreadyExistsException - Thrown, when there is already a task with this name.

addTask

public Long addTask(String uniqueTaskName,
                    boolean active,
                    Long interval,
                    Date nextExecutionDate,
                    Map<String,String> properties,
                    Class<? extends TaskHandler> handlerClass)
             throws TaskAlreadyExistsException

Description copied from interface: TaskManagement

Add a new task.

Specified by:

addTask in interface TaskManagement

Parameters:

uniqueTaskName - Unique name for this task.

active - True, if active.

interval - Interval for the execution.

nextExecutionDate - The next execution date.

properties - Properties of this task.

handlerClass - Class of the handler.

Returns:

The id of the Task.

Throws:

TaskAlreadyExistsException - Thrown, when there is already a task with this name.

addTask

public Long addTask(String uniqueTaskName,
                    boolean active,
                    Long interval,
                    Date nextExecutionDate,
                    Map<String,String> properties,
                    String handlerClass)
             throws TaskAlreadyExistsException

Description copied from interface: TaskManagement

Add a new task.

Specified by:

addTask in interface TaskManagement

Parameters:

uniqueTaskName - Unique name for this task.

active - True, if active.

interval - Interval for the execution.

nextExecutionDate - The next execution date.

properties - Properties of this task.

handlerClass - Full qualified class name for the handler.

Returns:

The id of the Task.

Throws:

TaskAlreadyExistsException - Thrown, when there is already a task with this name.

addTask

public Long addTask(String uniqueTaskName,
                    boolean active,
                    Long interval,
                    Date nextExecutionDate,
                    String handlerClass)
             throws TaskAlreadyExistsException

Description copied from interface: TaskManagement

Add a new task.

Specified by:

addTask in interface TaskManagement

Parameters:

uniqueTaskName - Unique name for this task.

active - True, if active.

interval - Interval for the execution.

nextExecutionDate - The next execution date.

handlerClass - Full qualified class name for the handler.

Returns:

The id of the Task.

Throws:

TaskAlreadyExistsException - Thrown, when there is already a task with this name.

addTaskHandler

public void addTaskHandler(Class<? extends TaskHandler> taskHandler)

Description copied from interface: TaskManagement

Add a handler for tasks. The handler will be registered under its full class name. If a handler with the same name already exists it will be overwritten.

Specified by:

addTaskHandler in interface TaskManagement

Parameters:

taskHandler - the task handler to add

addTaskHandler

@Transactional(propagation=SUPPORTS)
public void addTaskHandler(String handlerName,
                                                                Class<? extends TaskHandler> taskHandler)

Description copied from interface: TaskManagement

Add a handler for tasks with the given name. If a handler with the same name already exists it will be overwritten.

Specified by:

addTaskHandler in interface TaskManagement

Parameters:

handlerName - the name of the handler to be used

taskHandler - the task handler to add

addTaskHandlerWithTask

@Transactional(propagation=NEVER)
public void addTaskHandlerWithTask(String handlerName,
                                                                     Class<? extends TaskHandler> taskHandlerClazz,
                                                                     Map<String,String> properties,
                                                                     long startOffset,
                                                                     boolean resetFailed)

Description copied from interface: TaskManagement

Add a task handler and create a task for it. If a task already exists which has an execution time before now + startOffset, the task will be rescheduled to run with the new start time (now + startOffset).

Specified by:

addTaskHandlerWithTask in interface TaskManagement

Parameters:

handlerName - the name of the handler. The name will also be used as unique name for the task.

taskHandlerClazz - the TaskHandler class

properties - Properties for the task (if one is added).

startOffset - the offset in milliseconds to add to the current time to delay the execution of the task

resetFailed - if true and the status of an existing task is failed the task will be always rescheduled.

failTaskExecution

public void failTaskExecution(String uniqueTaskName)
                       throws InvalidInstanceException

Description copied from interface: TaskManagement

Mark the execution of a task as failed.

Specified by:

failTaskExecution in interface TaskManagement

Parameters:

uniqueTaskName - Name of the task.

Throws:

InvalidInstanceException - Thrown, when the task is not running on this instance.

findTask

@Transactional(readOnly=true)
public TaskTO findTask(String uniqueTaskName)

Description copied from interface: TaskManagement

Get the details of a task.

Specified by:

findTask in interface TaskManagement

Parameters:

uniqueTaskName - The name of the task

Returns:

the TO containing the details of the task or null if there is no task for that name. The handler of the task won't be set

getNextScheduledTask

public TaskTO getNextScheduledTask()

Description copied from interface: TaskManagement

Return the next task to be scheduled.

Specified by:

getNextScheduledTask in interface TaskManagement

Returns:

TaskTO or null if there is none.

getNextScheduledTask

public TaskTO getNextScheduledTask(Date upperBound)

Description copied from interface: TaskManagement

Return the next task to be scheduled.

Specified by:

getNextScheduledTask in interface TaskManagement

Parameters:

upperBound - The upper bound of the task's next execution (exclusive).

Returns:

TaskTO or null if there is none.

getNextScheduledTasks

public Collection<TaskTO> getNextScheduledTasks(Date upperBound,
                                                int maxTasks,
                                                Collection<Long> taskIdsToExclude)

Description copied from interface: TaskManagement

Get the tasks to schedule next

Specified by:

getNextScheduledTasks in interface TaskManagement

Parameters:

upperBound - NextExecution < UpperBound.

maxTasks - maximum number of tasks to return

taskIdsToExclude - the IDs of the task to exclude from the query. Can be null.

Returns:

List all tasks, which can be executed.

getTaskExecutions

@Transactional(readOnly=true)
public Collection<TaskExecution> getTaskExecutions(String instanceName)

Description copied from interface: TaskManagement

Return all task executions running on the Communote with the given name.

Specified by:

getTaskExecutions in interface TaskManagement

Parameters:

instanceName - Name of the instance

Returns:

List of task executions of the instance

isTaskRunningOnCurrentInstance

@Transactional(readOnly=true)
public boolean isTaskRunningOnCurrentInstance(String uniqueTaskName)

Description copied from interface: TaskManagement

Return whether the given task is running on the current instance.

Specified by:

isTaskRunningOnCurrentInstance in interface TaskManagement

Parameters:

uniqueTaskName - the unique name of the task

Returns:

true if the task is running on the current instance, false otherwise

killTaskExecution

public String killTaskExecution(Long executionId)

Description copied from interface: TaskManagement

Kill the task with given execution ID by removing the execution and setting the task back to pending.

Specified by:

killTaskExecution in interface TaskManagement

Parameters:

executionId - The execution ID

Returns:

The unique name of the task, which was killed, or null if there was none.

removeTask

public void removeTask(String uniqueTaskName)
                throws TaskAlreadyRunningException

Description copied from interface: TaskManagement

Remove a task if it is not RUNNING.

Specified by:

removeTask in interface TaskManagement

Parameters:

uniqueTaskName - The task to remove.

Throws:

TaskAlreadyRunningException - Thrown, when the task is currently running.

removeTaskHandler

@Transactional(propagation=SUPPORTS)
public boolean removeTaskHandler(String handlerName)

Description copied from interface: TaskManagement

Remove the task handler class from the list of known handlers.

Specified by:

removeTaskHandler in interface TaskManagement

Parameters:

handlerName - the handler name

Returns:

true if something has actually been removed

rescheduleTask

public void rescheduleTask(String uniqueTaskName,
                           Date nextExecutionDate)
                    throws TaskStatusException

Description copied from interface: TaskManagement

Reschedule a pending task.

Specified by:

rescheduleTask in interface TaskManagement

Parameters:

uniqueTaskName - the unique name of task. If there is no task with the given name the call will be ignored.

nextExecutionDate - the new execution date

Throws:

TaskStatusException - in case the task is not pending

resetTask

public void resetTask(String uniqueTaskName)

Description copied from interface: TaskManagement

Reset a task back from failed to pending. Also removes an existing execution.

Specified by:

resetTask in interface TaskManagement

Parameters:

uniqueTaskName - The name of the task to reset

startTaskExecution

@Transactional(propagation=NEVER)
public Long startTaskExecution(String uniqueTaskName)
                                                          throws TaskAlreadyRunningException,
                                                                 TaskNotActiveException,
                                                                 TaskManagementException

Description copied from interface: TaskManagement

Mark a task as running on this instance by creating an execution for it and setting the status to RUNNING. This call is ignored if the next execution timestamp of the task is in the future.

Specified by:

startTaskExecution in interface TaskManagement

Parameters:

uniqueTaskName - Name of the task to start.

Returns:

the ID of the created execution or null if the task does not exist or next execution timestamp is in the future

Throws:

TaskAlreadyRunningException - in case the task is already running.

TaskNotActiveException - in case the task is not activated.

TaskManagementException - in case of an unexpected error

startTaskExecutionTx

@Transactional(propagation=REQUIRES_NEW)
public Long startTaskExecutionTx(String uniqueTaskName)
                                                                   throws TaskNotActiveException,
                                                                          TaskAlreadyRunningException

Description copied from interface: TaskManagement

Same as TaskManagement.startTaskExecution(String) but can throw DatabaseIntegrityViolationException. Therefore this method should never be called directly and TaskManagement.startTaskExecution(String) should be used instead.

Specified by:

startTaskExecutionTx in interface TaskManagement

Parameters:

uniqueTaskName - Name of the task to start.

Returns:

the ID of the created execution or null if the task does not exist or next execution timestamp is in the future

Throws:

TaskNotActiveException - In case if the task is not activated.

TaskAlreadyRunningException - in case the task is already running.

stopAllTaskExecutions

public void stopAllTaskExecutions()

Description copied from interface: TaskManagement

Calls stopAllTaskExecutions(true,now).

Specified by:

stopAllTaskExecutions in interface TaskManagement

stopAllTaskExecutions

public void stopAllTaskExecutions(boolean resetFailed,
                                  Date rescheduleDate)

Description copied from interface: TaskManagement

End all task executions of this instance and schedules them again.

Specified by:

stopAllTaskExecutions in interface TaskManagement

Parameters:

resetFailed - If set, all failed tasks will be reset.

rescheduleDate - If set, this will be the new date the task will be executed.

stopTaskExecution

public void stopTaskExecution(String uniqueTaskName)
                       throws InvalidInstanceException

Description copied from interface: TaskManagement

End the execution of the given task.

Specified by:

stopTaskExecution in interface TaskManagement

Parameters:

uniqueTaskName - Name of the task.

Throws:

InvalidInstanceException - in case the task is not executed on this instance

stopTaskExecution

public void stopTaskExecution(String uniqueTaskName,
                              Date rescheduleDate)
                       throws InvalidInstanceException

Description copied from interface: TaskManagement

End the execution of the given task.

Specified by:

stopTaskExecution in interface TaskManagement

Parameters:

uniqueTaskName - Unique name of the task.

rescheduleDate - If set, this will be the new date the task will be executed.

Throws:

InvalidInstanceException - in case the task is not running on this instance