com.atlassian.confluence.schedule.managers

Interface ScheduledJobManager

All Known Implementing Classes:

DefaultScheduledJobManager

public interface ScheduledJobManager

Defines the services provided for manage scheduled jobs.

Generally a ManagedScheduleJobException is thrown if the input is invalid (e.g. job does not exist) or if the type of request is not permitted (e.g. execute runNow when the job is not set to canRunAdhoc).

Since:

3.5

Method Summary

Modifier and Type	Method and Description
void	disable(ScheduledJobKey key) Disables the specified job, and removes it from the scheduler.
void	enable(ScheduledJobKey key) Enables the specified job, and adds it to the scheduler.
String	getCronExpression(ScheduledJobKey key) Gets the currently configured cron expression, or the default value if none has been configured.
Long	getRepeatInterval(ScheduledJobKey key) Gets the currently configured repeat interval, or the default value if none has been configured.
ScheduledJobStatus	getScheduledJob(ScheduledJobKey key) Gets the current status for a single scheduled job.
List<ScheduledJobStatus>	getScheduledJobs() Gets the list of managed job status.
void	runNow(ScheduledJobKey key) Schedules the specified to run immediately.
Date	updateCronJobSchedule(ScheduledJobKey key, String newCronSchedule) Updates stored schedule.
Date	updateSimpleJobSchedule(ScheduledJobKey key, long repeatInterval) Updates stored schedule.

Method Detail

getScheduledJobs

List<ScheduledJobStatus> getScheduledJobs()

Gets the list of managed job status.

getScheduledJob

ScheduledJobStatus getScheduledJob(ScheduledJobKey key)

Gets the current status for a single scheduled job.

updateCronJobSchedule

Date updateCronJobSchedule(ScheduledJobKey key,
                           String newCronSchedule)

Updates stored schedule. If the job is being scheduled e.g. enabled, it will be rescheduled. If the job is not being scheduled e.g. disabled, it won't be rescheduled. Only valid for ManagedScheduledCronJob and requires AbstractManagedScheduledJob.isEditable() to be true.

Returns:

Date of the next execution

updateSimpleJobSchedule

Date updateSimpleJobSchedule(ScheduledJobKey key,
                             long repeatInterval)

Updates stored schedule. If the job is being scheduled e.g. enabled, it will be rescheduled. If the job is not being scheduled e.g. disabled, it won't be rescheduled. Only valid for ManagedScheduledSimpleJob and requires AbstractManagedScheduledJob.isEditable() to be true.

Returns:

Date of the next execution

runNow

void runNow(ScheduledJobKey key)

Schedules the specified to run immediately.

Requires ManagedScheduledJob.canRunAdhoc() to be true.

disable

void disable(ScheduledJobKey key)

Disables the specified job, and removes it from the scheduler.

Requires ManagedScheduledJob.canDisable() to be true.

enable

void enable(ScheduledJobKey key)

Enables the specified job, and adds it to the scheduler.

Requires ManagedScheduledJob.canDisable() to be true.

getCronExpression

String getCronExpression(ScheduledJobKey key)

Gets the currently configured cron expression, or the default value if none has been configured.

Returns:

null if not a cron job.

getRepeatInterval

Long getRepeatInterval(ScheduledJobKey key)

Gets the currently configured repeat interval, or the default value if none has been configured.

Returns:

null if not a simple job