public interface SchedulingService
ScheduledTask
s configuration and execution.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
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()
Deprecated.
|
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.
|
static final java.lang.String NAME
java.util.Map<java.lang.String,java.util.List<MethodInfo>> getAvailableBeans()
@Deprecated java.util.List<java.lang.String> getAvailableUsers()
User getUserByLogin(java.lang.String login)
login
- user login namejava.util.List<User> searchUsersByLogin(java.lang.String searchString)
searchString
- login stringvoid setActive(boolean active)
This method affects only the current run of each server. After server restart the
state of scheduling is defined by ServerConfig#getSchedulingActive()
configuration parameter.
active
- true to activate schedulingvoid setActive(ScheduledTask task, boolean active)
task
- task instanceactive
- true to activatevoid setActive(java.util.Set<ScheduledTask> tasks, boolean active)
tasks
- task instancesactive
- true to activatevoid runOnce(ScheduledTask task)
task
- task to executeRunTaskOnceException
- if you try to execute task once from not permitted server