com.haulmont.cuba.core.app.scheduling

Interface SchedulingAPI

All Known Implementing Classes:

Scheduling

public interface SchedulingAPI

Interface to control processing of ScheduledTasks.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.util.List<ScheduledTask>	getActiveTasks()
java.util.List<ScheduledTask>	getRunningTasks()
boolean	isActive() Whether the scheduling is currently active.
void	processScheduledTasks() Process all active scheduled tasks once.
void	processScheduledTasks(boolean onlyIfActive)
void	runOnce(ScheduledTask task) Runs a task right now and only once.
void	setActive(boolean value) Activate/deactivate scheduling.
void	setFinished(ScheduledTask task) Mark the scheduled task as finished in the internal list.
boolean	setRunning(ScheduledTask task, boolean running) Mark the scheduled task as running/not running in the internal list.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

isActive

boolean isActive()

Whether the scheduling is currently active. Default value is defined by SchedulingConfig.getSchedulingActive() configuration parameter.

Returns:

true if scheduling is active

setActive

void setActive(boolean value)

Activate/deactivate scheduling. This method affects only the current server run. After restart the state of scheduling is defined by SchedulingConfig.getSchedulingActive() configuration parameter.

Parameters:

value - true to activate scheduling

processScheduledTasks

void processScheduledTasks()

Process all active scheduled tasks once. This method should be invoked from a Spring scheduler, e.g.:

<task:scheduled ref="cuba_Scheduling" method="processScheduledTasks" fixed-rate="1000"/>

This methods returns immediately if scheduling is not active.

processScheduledTasks

void processScheduledTasks(boolean onlyIfActive)

setRunning

boolean setRunning(ScheduledTask task,
                   boolean running)

Mark the scheduled task as running/not running in the internal list. This method should not be used in the application code.

Parameters:

task - task instance

running - true to mark as running, false to mark as not running

Returns:

flag indicates concurrent task execution if value is true

setFinished

void setFinished(ScheduledTask task)

Mark the scheduled task as finished in the internal list. This method should not be used in the application code.

Parameters:

task - task instance

getActiveTasks

java.util.List<ScheduledTask> getActiveTasks()

Returns:

a list of active task instances in detached state

runOnce

void runOnce(ScheduledTask task)

Runs a task right now and only once.

Parameters:

task - task to execute

Throws:

RunTaskOnceException - if you try to execute task once from not permitted server

getRunningTasks

java.util.List<ScheduledTask> getRunningTasks()

Returns:

a list of running scheduled tasks