com.haulmont.cuba.core.app

Interface SchedulingService

All Known Implementing Classes:

SchedulingServiceBean

public interface SchedulingService

Service interface to control ScheduledTasks configuration and execution.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<MethodInfo>>	getAvailableBeans() Return information about beans and their methods that can be invoked by scheduled tasks.
java.util.List<ScheduledTask>	getRunningTasks()
User	getUserByLogin(java.lang.String login) Return a user by user login name.
void	runOnce(ScheduledTask task) Runs a task right now and only once.
java.util.List<User>	searchUsersByLogin(java.lang.String searchString) Return a list of users filtered by login using LIKE clause.
void	setActive(boolean active) Activate/deactivate scheduling for all servers in the cluster.
void	setActive(ScheduledTask task, boolean active) Activate/deactivate specific task.
void	setActive(java.util.Set<ScheduledTask> tasks, boolean active) Activate or deactivate set of scheduled tasks.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getAvailableBeans

java.util.Map<java.lang.String,java.util.List<MethodInfo>> getAvailableBeans()

Return information about beans and their methods that can be invoked by scheduled tasks.

Returns:

map of bean names to lists of their methods

getUserByLogin

User getUserByLogin(java.lang.String login)

Return a user by user login name.

Parameters:

login - user login name

Returns:

user

searchUsersByLogin

java.util.List<User> searchUsersByLogin(java.lang.String searchString)

Return a list of users filtered by login using LIKE clause.

Parameters:

searchString - login string

Returns:

list of users

setActive

void setActive(boolean active)

Activate/deactivate scheduling for all servers in the cluster.

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

Parameters:

active - true to activate scheduling

setActive

void setActive(ScheduledTask task,
               boolean active)

Activate/deactivate specific task.

Parameters:

task - task instance

active - true to activate

setActive

void setActive(java.util.Set<ScheduledTask> tasks,
               boolean active)

Activate or deactivate set of scheduled tasks.

Parameters:

tasks - task instances

active - true to activate

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