com.atlassian.confluence.schedule.managers

Interface ScheduledJobManager

All Known Implementing Classes:

DefaultScheduledJobManager

@Transactional
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
default void	disable(com.atlassian.scheduler.config.JobId jobId)
void	disable(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use disable(JobId)
default void	enable(com.atlassian.scheduler.config.JobId jobId)
void	enable(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use enable(JobId)
default String	getCronExpression(com.atlassian.scheduler.config.JobId jobId)
String	getCronExpression(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use getCronExpression(JobId)
default Long	getRepeatInterval(com.atlassian.scheduler.config.JobId jobId)
Long	getRepeatInterval(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use getRepeatInterval(JobId)
default ScheduledJobStatus	getScheduledJob(com.atlassian.scheduler.config.JobId jobId)
ScheduledJobStatus	getScheduledJob(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use getScheduledJob(JobId)
List<ScheduledJobStatus>	getScheduledJobs() Gets the list of managed job status.
default void	runNow(com.atlassian.scheduler.config.JobId jobId)
void	runNow(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use runNow(JobId)
default Date	updateCronJobSchedule(com.atlassian.scheduler.config.JobId jobId, String newCronSchedule)
Date	updateCronJobSchedule(ScheduledJobKey key, String newCronSchedule) Deprecated. since 7.18. To be removed in 8.0. Use updateCronJobSchedule(JobId, String)
default Date	updateSimpleJobSchedule(com.atlassian.scheduler.config.JobId jobId, long repeatInterval)
Date	updateSimpleJobSchedule(ScheduledJobKey key, long repeatInterval) Deprecated. since 7.18. To be removed in 8.0. Use updateSimpleJobSchedule(JobId, long)

Method Detail

getScheduledJobs

@Transactional(readOnly=true)
List<ScheduledJobStatus> getScheduledJobs()

Gets the list of managed job status.

getScheduledJob

@Deprecated
 @Transactional(readOnly=true)
ScheduledJobStatus getScheduledJob(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use getScheduledJob(JobId)

Gets the current status for a single scheduled job.

getScheduledJob

@Transactional(readOnly=true)
default ScheduledJobStatus getScheduledJob(com.atlassian.scheduler.config.JobId jobId)

updateCronJobSchedule

@Deprecated
Date updateCronJobSchedule(ScheduledJobKey key,
                                       String newCronSchedule)

Deprecated. since 7.18. To be removed in 8.0. Use updateCronJobSchedule(JobId, String)

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

updateCronJobSchedule

default Date updateCronJobSchedule(com.atlassian.scheduler.config.JobId jobId,
                                   String newCronSchedule)

updateSimpleJobSchedule

@Deprecated
Date updateSimpleJobSchedule(ScheduledJobKey key,
                                         long repeatInterval)

Deprecated. since 7.18. To be removed in 8.0. Use updateSimpleJobSchedule(JobId, long)

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

updateSimpleJobSchedule

default Date updateSimpleJobSchedule(com.atlassian.scheduler.config.JobId jobId,
                                     long repeatInterval)

runNow

@Deprecated
void runNow(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use runNow(JobId)

Schedules the specified to run immediately.

Requires ManagedScheduledJob.canRunAdhoc() to be true.

runNow

default void runNow(com.atlassian.scheduler.config.JobId jobId)

disable

@Deprecated
void disable(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use disable(JobId)

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

Requires ManagedScheduledJob.canDisable() to be true.

disable

default void disable(com.atlassian.scheduler.config.JobId jobId)

enable

@Deprecated
void enable(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use enable(JobId)

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

Requires ManagedScheduledJob.canDisable() to be true.

enable

default void enable(com.atlassian.scheduler.config.JobId jobId)

getCronExpression

@Deprecated
 @Transactional(readOnly=true)
String getCronExpression(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use getCronExpression(JobId)

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

Returns:

null if not a cron job.

getCronExpression

@Transactional(readOnly=true)
default String getCronExpression(com.atlassian.scheduler.config.JobId jobId)

getRepeatInterval

@Deprecated
 @Transactional(readOnly=true)
Long getRepeatInterval(ScheduledJobKey key)

Deprecated. since 7.18. To be removed in 8.0. Use getRepeatInterval(JobId)

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

Returns:

null if not a simple job

getRepeatInterval

@Transactional(readOnly=true)
default Long getRepeatInterval(com.atlassian.scheduler.config.JobId jobId)