ai.grakn.engine.backgroundtasks.distributed

Class DistributedTaskManager

java.lang.Object

ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager

All Implemented Interfaces:

TaskManager, AutoCloseable

public class DistributedTaskManager
extends Object
implements TaskManager

Class to manage tasks distributed using Kafka.

Constructor Summary

Constructors

Constructor and Description
DistributedTaskManager()

Method Summary

Modifier and Type	Method and Description
void	close()
CompletableFuture	completableFuture(String taskId) Return a future that allows registering asynchronous callbacks triggered when a task is completed.
static DistributedTaskManager	getInstance()
TaskStatus	getState(String taskID)
DistributedTaskManager	open()
String	scheduleTask(BackgroundTask task, String createdBy, Date runAt, long period, org.json.JSONObject configuration) Schedule a single shot/one off BackgroundTask to run after a @delay in milliseconds.
TaskManager	stopTask(String id, String requesterName) Stop a Scheduled, Paused or Running task.
StateStorage	storage() Return the StateStorage instance that is used by this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedTaskManager

public DistributedTaskManager()

Method Detail

getInstance

public static DistributedTaskManager getInstance()

open

public DistributedTaskManager open()

Specified by:

open in interface TaskManager

close

public void close()

Specified by:

close in interface AutoCloseable

scheduleTask

public String scheduleTask(BackgroundTask task,
                           String createdBy,
                           Date runAt,
                           long period,
                           org.json.JSONObject configuration)

Description copied from interface: TaskManager

Schedule a single shot/one off BackgroundTask to run after a @delay in milliseconds. All parameters must not be null unless stated otherwise.

Specified by:

scheduleTask in interface TaskManager

Parameters:

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

runAt - Date when task should run.

period - A non-zero value indicates that this should be a recurring task and period indicates the delay between subsequent runs of the task after successful execution.

configuration - A JSONObject instance containing configuration and optionally data for the task. This is an optional parameter and may be set to null to not pass any configuration (task.start() will get an initialised but empty JSONObject).

Returns:

Assigned ID of task scheduled for later execution.

stopTask

public TaskManager stopTask(String id,
                            String requesterName)

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:

id - String of task to stop.

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

Returns:

Instance of the class implementing TaskManager.

storage

public StateStorage storage()

Description copied from interface: TaskManager

Return the StateStorage instance that is used by this class.

Specified by:

storage in interface TaskManager

Returns:

A StateStorage instance.

completableFuture

public CompletableFuture completableFuture(String taskId)

Description copied from interface: TaskManager

Return a future that allows registering asynchronous callbacks triggered when a task is completed.

Specified by:

completableFuture in interface TaskManager

Parameters:

taskId - ID of task to track

Returns:

A CompletableFuture instance monitoring the status of the given task.

getState

public TaskStatus getState(String taskID)