com.atlassian.sal.api.scheduling

Interface PluginScheduler

All Known Implementing Classes:

DefaultPluginScheduler, ExecutorPluginScheduler, TimerPluginScheduler

Deprecated.

in 3.0 for removal in 4.0. Use Atlassian Scheduler instead

@Deprecated
public interface PluginScheduler

Interface for scheduling jobs

Since:

2.0

Method Summary

Modifier and Type	Method and Description
void	scheduleJob(String jobKey, Class<? extends PluginJob> jobClass, Map<String,Object> jobDataMap, Date startTime, long repeatInterval) Deprecated. Schedule the given job.
void	unscheduleJob(String jobKey) Deprecated. Unschedule the given job.

Method Detail

scheduleJob

void scheduleJob(String jobKey,
                 Class<? extends PluginJob> jobClass,
                 Map<String,Object> jobDataMap,
                 Date startTime,
                 long repeatInterval)

Deprecated.

Schedule the given job.

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()

Parameters:

jobKey - A unique key of the job

jobClass - The class for the job

jobDataMap - 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 implementations

unscheduleJob

void unscheduleJob(String jobKey)

Deprecated.

Unschedule the given job. If the job doesn't exist then IllegalArgumentException will be thrown.

Parameters:

jobKey - The job key to unschedule

Throws:

IllegalArgumentException - If the job doesn't exist thus cannot be unscheduled.