com.haulmont.cuba.core.app.scheduling

Class Scheduling

java.lang.Object

com.haulmont.cuba.core.app.scheduling.Scheduling

All Implemented Interfaces:

SchedulingAPI

@Component(value="cuba_Scheduling")
public class Scheduling
extends java.lang.Object
implements SchedulingAPI

Class that manages ScheduledTasks in distributed environment.

Field Summary

Fields inherited from interface com.haulmont.cuba.core.app.scheduling.SchedulingAPI

NAME

Constructor Summary

Constructors

Constructor and Description
Scheduling()

Method Summary

Modifier and Type	Method and Description
java.util.List<ScheduledTask>	getActiveTasks()
boolean	isActive() Whether the scheduling is currently active.
void	processScheduledTasks() Process all active scheduled tasks once.
void	processScheduledTasks(boolean onlyIfActive)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scheduling

public Scheduling()

Method Detail

processScheduledTasks

public void processScheduledTasks()

Description copied from interface: SchedulingAPI

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.

Specified by:

processScheduledTasks in interface SchedulingAPI

processScheduledTasks

public void processScheduledTasks(boolean onlyIfActive)

Specified by:

processScheduledTasks in interface SchedulingAPI

setRunning

public boolean setRunning(ScheduledTask task,
                          boolean running)

Description copied from interface: SchedulingAPI

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

Specified by:

setRunning in interface SchedulingAPI

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

public void setFinished(ScheduledTask task)

Description copied from interface: SchedulingAPI

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

Specified by:

setFinished in interface SchedulingAPI

Parameters:

task - task instance

isActive

public boolean isActive()

Description copied from interface: SchedulingAPI

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

Specified by:

isActive in interface SchedulingAPI

Returns:

true if scheduling is active

setActive

public void setActive(boolean value)

Description copied from interface: SchedulingAPI

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

Specified by:

setActive in interface SchedulingAPI

Parameters:

value - true to activate scheduling

getActiveTasks

public java.util.List<ScheduledTask> getActiveTasks()

Specified by:

getActiveTasks in interface SchedulingAPI

Returns:

a list of active task instances in detached state