|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginScheduler
Interface for scheduling jobs
Method Summary | |
---|---|
void |
scheduleJob(String jobKey,
Class<? extends PluginJob> jobClass,
Map<String,Object> jobDataMap,
Date startTime,
long repeatInterval)
Schedule the given job. |
void |
unscheduleJob(String jobKey)
Unschedule the given job. |
Method Detail |
---|
void scheduleJob(String jobKey, Class<? extends PluginJob> jobClass, Map<String,Object> jobDataMap, Date startTime, long repeatInterval)
WARNING: it is very important not to try to call this method until the underlying application
is fully started. You should implement LifecycleAware
and call scheduleJob()
only on LifecycleAware.onStart()
jobKey
- A unique key of the jobjobClass
- The class for the jobjobDataMap
- Any data that needs to be passed to the job. This map instance will always be the same
instance that is given to the job when it executes.startTime
- The time the job is to start.repeatInterval
- How long the interval between repeats, in milliseconds. Note, some implementationsvoid unscheduleJob(String jobKey)
jobKey
- The job key to unschedule
IllegalArgumentException
- If the job doesn't exist thus cannot be unscheduled.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |