ai.grakn.engine.backgroundtasks

Class AbstractTaskManager

java.lang.Object

ai.grakn.engine.backgroundtasks.AbstractTaskManager

All Implemented Interfaces:

TaskManager

Direct Known Subclasses:

InMemoryTaskManager

public abstract class AbstractTaskManager
extends Object
implements TaskManager

Constructor Summary

Constructors

Constructor and Description
AbstractTaskManager()

Method Summary

Modifier and Type	Method and Description
protected abstract void	executeRecurring(UUID uuid, BackgroundTask task, long delay, long interval)
protected abstract void	executeSingle(UUID uuid, BackgroundTask task, long delay)
protected abstract ScheduledFuture<BackgroundTask>	getTaskExecutionStatus(UUID uuid)
protected abstract BackgroundTask	instantiateTask(String className)
protected abstract UUID	saveNewState(TaskState state)
UUID	scheduleRecurringTask(BackgroundTask task, long delay, long interval) Schedule a task for recurring execution at every @period interval and after an initial @delay.
UUID	scheduleTask(BackgroundTask task, long delay) Schedule a single shot/one off BackgroundTask to run after a @delay in milliseconds.
TaskManager	stopTask(UUID uuid, String requesterName, String message) Stop a Scheduled, Paused or Running task.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.engine.backgroundtasks.TaskManager

getAllTasks, getTasks, getTaskState

Constructor Detail

AbstractTaskManager

public AbstractTaskManager()

Method Detail

scheduleTask

public UUID scheduleTask(BackgroundTask task,
                         long delay)

Description copied from interface: TaskManager

Schedule a single shot/one off BackgroundTask to run after a @delay in milliseconds.

Specified by:

scheduleTask in interface TaskManager

Parameters:

task - Any object implementing the BackgroundTask interface that is to be scheduled for later execution.

delay - Delay after which the @task object should be executed, may be null.

Returns:

Assigned UUID of task scheduled for later execution.

scheduleRecurringTask

public UUID scheduleRecurringTask(BackgroundTask task,
                                  long delay,
                                  long interval)

Description copied from interface: TaskManager

Schedule a task for recurring execution at every @period interval and after an initial @delay.

Specified by:

scheduleRecurringTask in interface TaskManager

Parameters:

task - Any object implementing the BackgroundTask interface that is to be scheduled for later execution.

delay - Long delay after which the @task object should be executed, may be null.

interval - Long interval between subsequent calls to @task.start().

Returns:

Assigned UUID of task scheduled for later execution.

stopTask

public TaskManager stopTask(UUID uuid,
                            String requesterName,
                            String message)

Description copied from interface: TaskManager

Stop a Scheduled, Paused or Running task. Task's .stop() method will be called to perform any cleanup and the task is killed afterwards.

Specified by:

stopTask in interface TaskManager

Parameters:

uuid - UUID of task to stop.

requesterName - Optional String to denote who requested this call; used for status reporting and may be null.

message - Optional String denoting the reason for stopping the task; used for status reporting and may be null.

Returns:

Instance of the class implementing TaskManager.

saveNewState

protected abstract UUID saveNewState(TaskState state)

getTaskExecutionStatus

protected abstract ScheduledFuture<BackgroundTask> getTaskExecutionStatus(UUID uuid)

executeSingle

protected abstract void executeSingle(UUID uuid,
                                      BackgroundTask task,
                                      long delay)

executeRecurring

protected abstract void executeRecurring(UUID uuid,
                                         BackgroundTask task,
                                         long delay,
                                         long interval)

instantiateTask

protected abstract BackgroundTask instantiateTask(String className)
                                           throws ClassNotFoundException,
                                                  InstantiationException,
                                                  IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException