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

Modifier and Type	Field and Description
protected io.jmix.core.security.SystemAuthenticator	authenticator
protected Configuration	configuration
protected Coordinator	coordinator
protected java.util.Map<ScheduledTask,java.lang.Long>	lastFinishCache
protected java.util.Map<ScheduledTask,java.lang.Long>	lastStartCache
protected Runner	runner
protected java.util.concurrent.ConcurrentMap<ScheduledTask,java.lang.Long>	runningTasks
protected long	schedulingStartTime
protected ServerInfoAPI	serverInfo
protected ServerInfoService	serverInfoService
protected io.jmix.core.TimeSource	timeSource

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
protected long	calculateNextCronDate(ScheduledTask task, long date, long currentDate, long frame)
protected long	calculateNextDelayDate(ScheduledTask task, long lastStart, long lastFinish, long currentDate, long frame, long period)
protected long	calculateNextPeriodDate(ScheduledTask task, long date, long currentDate, long frame, long period)
protected boolean	checkFirst(ScheduledTask task, java.lang.Integer serverPriority, long now)
java.util.List<ScheduledTask>	getActiveTasks()
protected java.util.TimeZone	getCurrentTimeZone()
java.util.List<ScheduledTask>	getRunningTasks()
protected long	getSchedulingInterval()
protected java.lang.Integer	getServerPriority(ScheduledTask task, java.lang.String serverId)
boolean	isActive() Whether the scheduling is currently active.
protected boolean	isRunning(ScheduledTask task)
protected boolean	lastServerWasNotMe(ScheduledTask task, java.lang.String me)
protected boolean	needToStartInTimeFrame(long now, long frame, long lastStart, long currentStart)
void	processScheduledTasks() Process all active scheduled tasks once.
void	processScheduledTasks(boolean onlyIfActive)
protected void	processTask(ScheduledTask task)
void	runOnce(ScheduledTask task) Runs a task right now and only once.
protected void	runSingletonTask(ScheduledTask task, long now, java.lang.String server)
protected void	runTask(ScheduledTask task, long time)
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

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

Field Detail

configuration

@Inject
protected Configuration configuration

serverInfo

@Inject
protected ServerInfoAPI serverInfo

timeSource

@Inject
protected io.jmix.core.TimeSource timeSource

authenticator

@Inject
protected io.jmix.core.security.SystemAuthenticator authenticator

coordinator

@Inject
protected Coordinator coordinator

runner

@Inject
protected Runner runner

serverInfoService

@Inject
protected ServerInfoService serverInfoService

runningTasks

protected java.util.concurrent.ConcurrentMap<ScheduledTask,java.lang.Long> runningTasks

lastStartCache

protected java.util.Map<ScheduledTask,java.lang.Long> lastStartCache

lastFinishCache

protected java.util.Map<ScheduledTask,java.lang.Long> lastFinishCache

schedulingStartTime

protected volatile long schedulingStartTime

Constructor Detail

Scheduling

public Scheduling()

Method Detail

processScheduledTasks

@Scheduled(fixedRate=1000L)
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 SchedulingConfig.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 SchedulingConfig.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

getSchedulingInterval

protected long getSchedulingInterval()

processTask

protected void processTask(ScheduledTask task)

needToStartInTimeFrame

protected boolean needToStartInTimeFrame(long now,
                                         long frame,
                                         long lastStart,
                                         long currentStart)

calculateNextCronDate

protected long calculateNextCronDate(ScheduledTask task,
                                     long date,
                                     long currentDate,
                                     long frame)

calculateNextPeriodDate

protected long calculateNextPeriodDate(ScheduledTask task,
                                       long date,
                                       long currentDate,
                                       long frame,
                                       long period)

calculateNextDelayDate

protected long calculateNextDelayDate(ScheduledTask task,
                                      long lastStart,
                                      long lastFinish,
                                      long currentDate,
                                      long frame,
                                      long period)

getCurrentTimeZone

protected java.util.TimeZone getCurrentTimeZone()

lastServerWasNotMe

protected boolean lastServerWasNotMe(ScheduledTask task,
                                     java.lang.String me)

runSingletonTask

protected void runSingletonTask(ScheduledTask task,
                                long now,
                                java.lang.String server)
                         throws javax.security.auth.login.LoginException

Throws:

javax.security.auth.login.LoginException

runTask

protected void runTask(ScheduledTask task,
                       long time)
                throws javax.security.auth.login.LoginException

Throws:

javax.security.auth.login.LoginException

checkFirst

protected boolean checkFirst(ScheduledTask task,
                             java.lang.Integer serverPriority,
                             long now)

getServerPriority

protected java.lang.Integer getServerPriority(ScheduledTask task,
                                              java.lang.String serverId)

isRunning

protected boolean isRunning(ScheduledTask task)

runOnce

public void runOnce(ScheduledTask task)

Description copied from interface: SchedulingAPI

Runs a task right now and only once.

Specified by:

runOnce in interface SchedulingAPI

Parameters:

task - task to execute

getRunningTasks

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

Specified by:

getRunningTasks in interface SchedulingAPI

Returns:

a list of running scheduled tasks