com.haulmont.cuba.core.app.scheduling

Class SchedulingServiceBean

java.lang.Object

com.haulmont.cuba.core.app.scheduling.SchedulingServiceBean

All Implemented Interfaces:

SchedulingService

@Service(value="cuba_ScheduledTasksService")
public class SchedulingServiceBean
extends java.lang.Object
implements SchedulingService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchedulingServiceBean.SetSchedulingActiveMsg

Field Summary

Fields

Modifier and Type	Field and Description
protected DataManager	dataManager
protected Persistence	persistence
protected SchedulingBeansMetadata	schedulingBeansMetadata

Fields inherited from interface com.haulmont.cuba.core.app.SchedulingService

NAME

Constructor Summary

Constructors

Constructor and Description
SchedulingServiceBean()

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<java.lang.String>	getAvailableUsers() Return a list of user login names that can be used by scheduled tasks.
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.
void	setClusterManager(ClusterManagerAPI clusterManager)

Methods inherited from class java.lang.Object

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

Field Detail

persistence

@Inject
protected Persistence persistence

schedulingBeansMetadata

@Inject
protected SchedulingBeansMetadata schedulingBeansMetadata

dataManager

@Inject
protected DataManager dataManager

Constructor Detail

SchedulingServiceBean

public SchedulingServiceBean()

Method Detail

setClusterManager

@Inject
public void setClusterManager(ClusterManagerAPI clusterManager)

getAvailableBeans

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

Description copied from interface: SchedulingService

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

Specified by:

getAvailableBeans in interface SchedulingService

Returns:

map of bean names to lists of their methods

getAvailableUsers

public java.util.List<java.lang.String> getAvailableUsers()

Description copied from interface: SchedulingService

Return a list of user login names that can be used by scheduled tasks.

Specified by:

getAvailableUsers in interface SchedulingService

Returns:

list of user login names

getUserByLogin

public User getUserByLogin(java.lang.String login)

Description copied from interface: SchedulingService

Return a user by user login name.

Specified by:

getUserByLogin in interface SchedulingService

Parameters:

login - user login name

Returns:

user

searchUsersByLogin

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

Description copied from interface: SchedulingService

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

Specified by:

searchUsersByLogin in interface SchedulingService

Parameters:

searchString - login string

Returns:

list of users

setActive

public void setActive(boolean active)

Description copied from interface: SchedulingService

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.

Specified by:

setActive in interface SchedulingService

Parameters:

active - true to activate scheduling

setActive

public void setActive(ScheduledTask task,
                      boolean active)

Description copied from interface: SchedulingService

Activate/deactivate specific task.

Specified by:

setActive in interface SchedulingService

Parameters:

task - task instance

active - true to activate

setActive

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

Description copied from interface: SchedulingService

Activate or deactivate set of scheduled tasks.

Specified by:

setActive in interface SchedulingService

Parameters:

tasks - task instances

active - true to activate

runOnce

public void runOnce(ScheduledTask task)

Description copied from interface: SchedulingService

Runs a task right now and only once.

Specified by:

runOnce in interface SchedulingService

Parameters:

task - task to execute