com.atlassian.confluence.schedule.managers

Class DefaultScheduledJobManager

java.lang.Object

com.atlassian.confluence.schedule.managers.DefaultScheduledJobManager

All Implemented Interfaces:

ScheduledJobNodeManager, ScheduledJobManager

public class DefaultScheduledJobManager
extends Object
implements ScheduledJobManager, ScheduledJobNodeManager

Implementation of the ScheduledJobManager, co-ordinates access to the scheduler, persisted configuration (in Bandana), transient status (in caches), and static data (in the job registry).

Constructor Summary

Constructors

Constructor and Description
DefaultScheduledJobManager(ScheduledJobDao jobDAO, org.quartz.Scheduler scheduler, com.atlassian.scheduler.SchedulerService schedulerService, ManagedScheduledJobRegistry jobRegistry, AuditService auditService, ScheduleJobStatusManager statusManager, com.atlassian.sal.api.timezone.TimeZoneManager timeZoneManager, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
void	disable(ScheduledJobKey key) Disables the specified job, and removes it from the scheduler.
void	disableJob(ScheduledJobKey key) Disable job on this node only.
void	enable(ScheduledJobKey key) Enables the specified job, and adds it to the scheduler.
void	enableJob(ScheduledJobKey key) Enable job on this node only.
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.
static ScheduledJobKey	jobIdToScheduledJobKeyWithoutRunNowSuffix(com.atlassian.scheduler.config.JobId jobId) See the implementation of runNow(com.atlassian.confluence.schedule.ScheduledJobKey).
void	runNow(ScheduledJobKey key) Schedules the specified to run immediately.
static com.atlassian.scheduler.config.JobId	scheduledJobKeyToJobIdWithRunNowSuffix(ScheduledJobKey scheduledJobKey) See the implementation of runNow(com.atlassian.confluence.schedule.ScheduledJobKey).
Date	updateCronJobSchedule(ScheduledJobKey key, String newCronSchedule) Updates stored schedule.
Date	updateCronSchedule(ScheduledJobKey key, String newCronSchedule)
void	updateDisabledJobExecutionStatus(ScheduledJobKey key, ScheduledJobStatus jobStatus)
void	updateEnabledJobExecutionStatus(ScheduledJobKey key, ScheduledJobStatus jobStatus)
Date	updateSimpleJobSchedule(ScheduledJobKey key, long repeatInterval) Updates stored schedule.
Date	updateSimpleSchedule(ScheduledJobKey key, long repeatInterval)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultScheduledJobManager

public DefaultScheduledJobManager(ScheduledJobDao jobDAO,
                                  org.quartz.Scheduler scheduler,
                                  com.atlassian.scheduler.SchedulerService schedulerService,
                                  ManagedScheduledJobRegistry jobRegistry,
                                  AuditService auditService,
                                  ScheduleJobStatusManager statusManager,
                                  com.atlassian.sal.api.timezone.TimeZoneManager timeZoneManager,
                                  com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getScheduledJobs

public List<ScheduledJobStatus> getScheduledJobs()

Description copied from interface: ScheduledJobManager

Gets the list of managed job status.

Specified by:

getScheduledJobs in interface ScheduledJobManager

getScheduledJob

public ScheduledJobStatus getScheduledJob(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

Gets the current status for a single scheduled job.

Specified by:

getScheduledJob in interface ScheduledJobManager

updateCronJobSchedule

public Date updateCronJobSchedule(ScheduledJobKey key,
                                  String newCronSchedule)

Description copied from interface: ScheduledJobManager

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.

Specified by:

updateCronJobSchedule in interface ScheduledJobManager

Returns:

Date of the next execution

updateCronSchedule

public Date updateCronSchedule(ScheduledJobKey key,
                               String newCronSchedule)

Specified by:

updateCronSchedule in interface ScheduledJobNodeManager

updateSimpleJobSchedule

public Date updateSimpleJobSchedule(ScheduledJobKey key,
                                    long repeatInterval)

Description copied from interface: ScheduledJobManager

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.

Specified by:

updateSimpleJobSchedule in interface ScheduledJobManager

Returns:

Date of the next execution

updateSimpleSchedule

public Date updateSimpleSchedule(ScheduledJobKey key,
                                 long repeatInterval)

Specified by:

updateSimpleSchedule in interface ScheduledJobNodeManager

runNow

public void runNow(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

Schedules the specified to run immediately.

Requires ManagedScheduledJob.canRunAdhoc() to be true.

Specified by:

runNow in interface ScheduledJobManager

disable

public void disable(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

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

Requires ManagedScheduledJob.canDisable() to be true.

Specified by:

disable in interface ScheduledJobManager

disableJob

public void disableJob(ScheduledJobKey key)

Description copied from interface: ScheduledJobNodeManager

Disable job on this node only.

Specified by:

disableJob in interface ScheduledJobNodeManager

Parameters:

key - the job key.

enable

public void enable(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

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

Requires ManagedScheduledJob.canDisable() to be true.

Specified by:

enable in interface ScheduledJobManager

enableJob

public void enableJob(ScheduledJobKey key)

Description copied from interface: ScheduledJobNodeManager

Enable job on this node only.

Specified by:

enableJob in interface ScheduledJobNodeManager

Parameters:

key - the job key.

updateEnabledJobExecutionStatus

public void updateEnabledJobExecutionStatus(ScheduledJobKey key,
                                            ScheduledJobStatus jobStatus)

updateDisabledJobExecutionStatus

public void updateDisabledJobExecutionStatus(ScheduledJobKey key,
                                             ScheduledJobStatus jobStatus)

getCronExpression

public String getCronExpression(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

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

Specified by:

getCronExpression in interface ScheduledJobManager

Returns:

null if not a cron job.

getRepeatInterval

public Long getRepeatInterval(ScheduledJobKey key)

Description copied from interface: ScheduledJobManager

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

Specified by:

getRepeatInterval in interface ScheduledJobManager

Returns:

null if not a simple job

scheduledJobKeyToJobIdWithRunNowSuffix

public static com.atlassian.scheduler.config.JobId scheduledJobKeyToJobIdWithRunNowSuffix(ScheduledJobKey scheduledJobKey)

See the implementation of runNow(com.atlassian.confluence.schedule.ScheduledJobKey).

jobIdToScheduledJobKeyWithoutRunNowSuffix

public static ScheduledJobKey jobIdToScheduledJobKeyWithoutRunNowSuffix(com.atlassian.scheduler.config.JobId jobId)

See the implementation of runNow(com.atlassian.confluence.schedule.ScheduledJobKey).