com.atlassian.confluence.schedule

Interface ManagedScheduledJob

All Superinterfaces:

ScheduledJob

All Known Implementing Classes:

AbstractManagedScheduledJob, ManagedScheduledCronJob, ManagedScheduledSimpleJob

public interface ManagedScheduledJob
extends ScheduledJob

Encapsulates the static configuration of a managed scheduled job. Implementations should be immutable. To ease the transition from Quartz (deprecated) to atlassian-scheduler, both Quartz job (deprecated, do not use) and atlassian-scheduler job are supported.

Since:

5.10

Method Summary

Modifier and Type	Method and Description
boolean	canDisable()
boolean	canRunAdhoc()
org.quartz.JobDetail	getJobDetail() For Quartz job.
long	getLockWaitTime()
ScheduledJobKey	getScheduledJobKey() Returns ScheduledJobKey.valueOf(JobDetail) when getJobDetail() returns non-null, or ScheduledJobKey.valueOf(JobId) when ScheduledJob.getJobConfig() returns non-null.
Optional<TimeoutPolicy>	getTimeoutPolicy()
static boolean	isCronJob(ManagedScheduledJob job) Utility to determine if a managed job is a cron job or not.
boolean	isEditable()
boolean	isKeepingHistory()
boolean	isLocalJob()
static boolean	isQuartzJob(ManagedScheduledJob job) Utility to determine if a managed job is scheduled by Quartz or not.

Methods inherited from interface com.atlassian.confluence.schedule.ScheduledJob

getJobConfig, getJobRunner, isClusteredOnly, sameJobId

Method Detail

getScheduledJobKey

ScheduledJobKey getScheduledJobKey()

Returns ScheduledJobKey.valueOf(JobDetail) when getJobDetail() returns non-null, or ScheduledJobKey.valueOf(JobId) when ScheduledJob.getJobConfig() returns non-null.

getJobDetail

org.quartz.JobDetail getJobDetail()

For Quartz job. Returns null when ScheduledJob.getJobRunner() and ScheduledJob.getJobConfig() return non-null.

isEditable

boolean isEditable()

isKeepingHistory

boolean isKeepingHistory()

canRunAdhoc

boolean canRunAdhoc()

canDisable

boolean canDisable()

getLockWaitTime

long getLockWaitTime()

isLocalJob

boolean isLocalJob()

getTimeoutPolicy

Optional<TimeoutPolicy> getTimeoutPolicy()

isQuartzJob

static boolean isQuartzJob(ManagedScheduledJob job)

Utility to determine if a managed job is scheduled by Quartz or not. Returns true when getJobDetail() returns non-null.

isCronJob

static boolean isCronJob(ManagedScheduledJob job)

Utility to determine if a managed job is a cron job or not.