Package org.cyclos.impl.utils.tasks

Interface BackgroundTaskHandler

All Known Subinterfaces:

BackgroundTaskHandlerImplementor

public interface BackgroundTaskHandler

Handles the execution of BackgroundTasks

Method Summary

Modifier and Type	Method	Description
CustomBackgroundTaskScheduling	custom(String internalName, String context)	Returns a new CustomBackgroundTaskScheduling which is used to schedule a custom background task
CustomBackgroundTaskScheduling	custom(String internalName, String context, Long forkJoinId)	Returns a new CustomBackgroundTaskScheduling which is used to schedule a custom background task, referencing a fork/join execution by id.
boolean	isScheduledOrRunning(Class<? extends BackgroundTask> type, Object context)	Returns whether the given background task type, with the given context, is either scheduled for execution or currently running
Long	newForkJoin(long taskCount, String joinCode, String... libraryInternalNames)	Creates a new Fork/Join process, which executes a custom script code after a given number of tasks finish.
boolean	remove(Long id)	Removes the scheduled task execution with the given id
Long	schedule(BackgroundTaskScheduling task)	Schedule a BackgroundTask to run

Method Detail

custom

CustomBackgroundTaskScheduling custom(String internalName,
                                      String context)

Returns a new CustomBackgroundTaskScheduling which is used to schedule a custom background task

custom

CustomBackgroundTaskScheduling custom(String internalName,
                                      String context,
                                      Long forkJoinId)

Returns a new CustomBackgroundTaskScheduling which is used to schedule a custom background task, referencing a fork/join execution by id.

isScheduledOrRunning

boolean isScheduledOrRunning(Class<? extends BackgroundTask> type,
                             Object context)

Returns whether the given background task type, with the given context, is either scheduled for execution or currently running

newForkJoin

Long newForkJoin(long taskCount,
                 String joinCode,
                 String... libraryInternalNames)

Creates a new Fork/Join process, which executes a custom script code after a given number of tasks finish. The script code may reference libraries by internal name

remove

boolean remove(Long id)

Removes the scheduled task execution with the given id

schedule

Long schedule(BackgroundTaskScheduling task)

Schedule a BackgroundTask to run