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()
default boolean	disabledByDefault()
org.quartz.JobDetail	getJobDetail() Deprecated. since 7.18. To be removed in 8.0 release.
default com.atlassian.scheduler.config.JobId	getJobId()
long	getLockWaitTime()
ScheduledJobKey	getScheduledJobKey() Deprecated. since 7.18. To be removed in 8.0. Use getJobId()
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) Deprecated. since 7.18. To be removed in 8.0 release.

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

getJobConfig, getJobRunner, isClusteredOnly, sameJobId

Method Detail

getScheduledJobKey

@Deprecated
ScheduledJobKey getScheduledJobKey()

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

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

getJobId

default com.atlassian.scheduler.config.JobId getJobId()

getJobDetail

@Deprecated
org.quartz.JobDetail getJobDetail()

Deprecated. since 7.18. To be removed in 8.0 release.

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

@Deprecated
static boolean isQuartzJob(ManagedScheduledJob job)

Deprecated. since 7.18. To be removed in 8.0 release.

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.

disabledByDefault

default boolean disabledByDefault()