com.atlassian.confluence.schedule

Class AbstractManagedScheduledJob

java.lang.Object

com.atlassian.confluence.schedule.AbstractManagedScheduledJob

All Implemented Interfaces:

ManagedScheduledJob, ScheduledJob

Direct Known Subclasses:

ManagedScheduledCronJob, ManagedScheduledSimpleJob

public abstract class AbstractManagedScheduledJob
extends Object
implements ManagedScheduledJob

Implements common properties for various implementations of ManagedScheduledJob.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_LOCK_WAIT_TIME_MS
static TimeoutPolicy	DEFAULT_TIMEOUT_POLICY
static String	LOCK_WAIT_TIME_PARAMETER_NAME
static String	TIMEOUT_POLICY_PARAMETER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractManagedScheduledJob(org.quartz.JobDetail jobDetail, boolean editable, boolean keepingHistory, boolean canRunAdhoc, boolean canDisable) Deprecated. since 5.10
protected	AbstractManagedScheduledJob(String jobId, com.atlassian.scheduler.JobRunner jobRunner, com.atlassian.scheduler.config.JobConfig jobConfig, boolean editable, boolean keepingHistory, boolean canRunAdhoc, boolean canDisable, boolean clusteredOnly) For atlassian-scheduler.
protected	AbstractManagedScheduledJob(String jobId, com.atlassian.scheduler.JobRunner jobRunner, com.atlassian.scheduler.config.JobConfig jobConfig, boolean editable, boolean keepingHistory, boolean canRunAdhoc, boolean canDisable, boolean clusteredOnly, long lockWaitTime, @Nullable TimeoutPolicy timeoutPolicy) For atlassian-scheduler.
protected	AbstractManagedScheduledJob(String jobId, com.atlassian.scheduler.JobRunner jobRunner, com.atlassian.scheduler.config.JobConfig jobConfig, boolean editable, boolean keepingHistory, boolean canRunAdhoc, boolean canDisable, boolean clusteredOnly, long lockWaitTime, @Nullable TimeoutPolicy timeoutPolicy, boolean disabledByDefault) For atlassian-scheduler.

Method Summary

Modifier and Type	Method and Description
boolean	canDisable()
boolean	canRunAdhoc()
boolean	disabledByDefault()
boolean	equals(Object o)
com.atlassian.scheduler.config.JobConfig	getJobConfig() When scheduling the job, ScheduleUtil.withTimeZone(JobConfig, TimeZone) may be used to set the time zone in case the job is cron based.
org.quartz.JobDetail	getJobDetail() For Quartz job.
com.atlassian.scheduler.JobRunner	getJobRunner() The JobRunnerKey to register the JobRunner result of this methos should be taken from the result of ScheduledJob.getJobConfig().
long	getLockWaitTime()
ScheduledJobKey	getScheduledJobKey() Returns ScheduledJobKey.valueOf(JobDetail) when ManagedScheduledJob.getJobDetail() returns non-null, or ScheduledJobKey.valueOf(JobId) when ScheduledJob.getJobConfig() returns non-null.
Optional<TimeoutPolicy>	getTimeoutPolicy()
int	hashCode()
boolean	isClusteredOnly() Jobs that are only meaningful in clustered environment won't be scheduled in non-clustered environments.
boolean	isEditable()
boolean	isKeepingHistory()
boolean	isLocalJob()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isCronJob, isQuartzJob

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

sameJobId

Field Detail

DEFAULT_LOCK_WAIT_TIME_MS

public static final long DEFAULT_LOCK_WAIT_TIME_MS

See Also:

Constant Field Values

DEFAULT_TIMEOUT_POLICY

public static final TimeoutPolicy DEFAULT_TIMEOUT_POLICY

LOCK_WAIT_TIME_PARAMETER_NAME

public static final String LOCK_WAIT_TIME_PARAMETER_NAME

See Also:

Constant Field Values

TIMEOUT_POLICY_PARAMETER_NAME

public static final String TIMEOUT_POLICY_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractManagedScheduledJob

@Deprecated
protected AbstractManagedScheduledJob(org.quartz.JobDetail jobDetail,
                                                  boolean editable,
                                                  boolean keepingHistory,
                                                  boolean canRunAdhoc,
                                                  boolean canDisable)

Deprecated. since 5.10

For Quartz.

AbstractManagedScheduledJob

protected AbstractManagedScheduledJob(String jobId,
                                      com.atlassian.scheduler.JobRunner jobRunner,
                                      com.atlassian.scheduler.config.JobConfig jobConfig,
                                      boolean editable,
                                      boolean keepingHistory,
                                      boolean canRunAdhoc,
                                      boolean canDisable,
                                      boolean clusteredOnly)

For atlassian-scheduler.

AbstractManagedScheduledJob

protected AbstractManagedScheduledJob(String jobId,
                                      com.atlassian.scheduler.JobRunner jobRunner,
                                      com.atlassian.scheduler.config.JobConfig jobConfig,
                                      boolean editable,
                                      boolean keepingHistory,
                                      boolean canRunAdhoc,
                                      boolean canDisable,
                                      boolean clusteredOnly,
                                      long lockWaitTime,
                                      @Nullable TimeoutPolicy timeoutPolicy)

For atlassian-scheduler.

AbstractManagedScheduledJob

protected AbstractManagedScheduledJob(String jobId,
                                      com.atlassian.scheduler.JobRunner jobRunner,
                                      com.atlassian.scheduler.config.JobConfig jobConfig,
                                      boolean editable,
                                      boolean keepingHistory,
                                      boolean canRunAdhoc,
                                      boolean canDisable,
                                      boolean clusteredOnly,
                                      long lockWaitTime,
                                      @Nullable TimeoutPolicy timeoutPolicy,
                                      boolean disabledByDefault)

For atlassian-scheduler.

Method Detail

getScheduledJobKey

public ScheduledJobKey getScheduledJobKey()

Description copied from interface: ManagedScheduledJob

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

Specified by:

getScheduledJobKey in interface ManagedScheduledJob

getJobDetail

public org.quartz.JobDetail getJobDetail()

Description copied from interface: ManagedScheduledJob

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

Specified by:

getJobDetail in interface ManagedScheduledJob

getJobRunner

public com.atlassian.scheduler.JobRunner getJobRunner()

Description copied from interface: ScheduledJob

The JobRunnerKey to register the JobRunner result of this methos should be taken from the result of ScheduledJob.getJobConfig().

Specified by:

getJobRunner in interface ScheduledJob

getJobConfig

public com.atlassian.scheduler.config.JobConfig getJobConfig()

Description copied from interface: ScheduledJob

When scheduling the job, ScheduleUtil.withTimeZone(JobConfig, TimeZone) may be used to set the time zone in case the job is cron based.

Specified by:

getJobConfig in interface ScheduledJob

isEditable

public boolean isEditable()

Specified by:

isEditable in interface ManagedScheduledJob

isKeepingHistory

public boolean isKeepingHistory()

Specified by:

isKeepingHistory in interface ManagedScheduledJob

canRunAdhoc

public boolean canRunAdhoc()

Specified by:

canRunAdhoc in interface ManagedScheduledJob

canDisable

public boolean canDisable()

Specified by:

canDisable in interface ManagedScheduledJob

isClusteredOnly

public boolean isClusteredOnly()

Description copied from interface: ScheduledJob

Jobs that are only meaningful in clustered environment won't be scheduled in non-clustered environments.

Specified by:

isClusteredOnly in interface ScheduledJob

isLocalJob

public boolean isLocalJob()

Specified by:

isLocalJob in interface ManagedScheduledJob

getLockWaitTime

public long getLockWaitTime()

Specified by:

getLockWaitTime in interface ManagedScheduledJob

getTimeoutPolicy

public Optional<TimeoutPolicy> getTimeoutPolicy()

Specified by:

getTimeoutPolicy in interface ManagedScheduledJob

disabledByDefault

public boolean disabledByDefault()

Specified by:

disabledByDefault in interface ManagedScheduledJob

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object