com.atlassian.confluence.schedule.persistence.dao

Interface ScheduledJobDao

All Known Implementing Classes:

CachedScheduledJobDao, ClusterSafeScheduledJobDao

public interface ScheduledJobDao

Provides the DAO for storing the various scheduled job objects.

Persistence may be in memory, local cache, clustered cache or to a persistent store.

Intended storage (see implementations):

• ScheduledJobStatus - memory / cache (runtime only)
• ExecutionStatus - memory / cache (runtime only)
• ScheduledJobHistory - peristent store and memory / cache
• ScheduledJobConfiguration - memory / cache (runtime only)
• Default Cron Configuration - (sourced from spring/plugin) - memory / cache (runtime only)

Method Summary

Modifier and Type	Method and Description
default void	addHistory(com.atlassian.scheduler.config.JobId jobId, @Nullable ScheduledJobHistory history, Date nextOccurrence)
void	addHistory(ScheduledJobKey key, @Nullable ScheduledJobHistory history, Date nextOccurrence) Deprecated. since 7.18. To be removed in 8.0. Use addHistory(JobId, ScheduledJobHistory, Date)
default @Nullable ScheduledJobConfiguration	getScheduledJobConfiguration(com.atlassian.scheduler.config.JobId jobId)
@Nullable ScheduledJobConfiguration	getScheduledJobConfiguration(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use getScheduledJobConfiguration(JobId)
default @Nullable ScheduledJobStatus	getScheduledJobStatus(com.atlassian.scheduler.config.JobId jobId)
@Nullable ScheduledJobStatus	getScheduledJobStatus(ScheduledJobKey key) Deprecated. since 7.18. To be removed in 8.0. Use getScheduledJobStatus(JobId)
default void	saveScheduledJobConfiguration(com.atlassian.scheduler.config.JobId jobId, ScheduledJobConfiguration jobConfiguration)
void	saveScheduledJobConfiguration(ScheduledJobKey key, ScheduledJobConfiguration jobConfiguration) Deprecated. since 7.18. To be removed in 8.0. Use saveScheduledJobConfiguration(JobId, ScheduledJobConfiguration)
default void	saveScheduledJobStatus(com.atlassian.scheduler.config.JobId jobId, ScheduledJobStatus status)
void	saveScheduledJobStatus(ScheduledJobKey key, ScheduledJobStatus status) Deprecated. since 7.18. To be removed in 8.0. Use saveScheduledJobStatus(JobId, ScheduledJobStatus)
void	updateNextOccurence(ScheduledJobKey key, Date nextOccurence) Deprecated. since 7.18. To be removed in 8.0. Use updateNextOccurrence(JobId, Date)
default void	updateNextOccurrence(com.atlassian.scheduler.config.JobId jobId, Date nextOccurrence)
default void	updateStatus(com.atlassian.scheduler.config.JobId jobId, ExecutionStatus status)
void	updateStatus(ScheduledJobKey key, ExecutionStatus status) Deprecated. since 7.18. To be removed in 8.0. Use updateStatus(JobId, ExecutionStatus)

Method Detail

getScheduledJobStatus

@Deprecated
@Nullable ScheduledJobStatus getScheduledJobStatus(ScheduledJobKey key)

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

Gets the specified job's status.

It's recommended that ScheduleJobStatusManager be used for access to a job's status, rather than this call directly. The manager handles cache expiry automatically.

Parameters:

key - the job key

Returns:

null if the job does not exist, or the status has expired from the cache.

getScheduledJobStatus

default @Nullable ScheduledJobStatus getScheduledJobStatus(com.atlassian.scheduler.config.JobId jobId)

saveScheduledJobStatus

@Deprecated
void saveScheduledJobStatus(ScheduledJobKey key,
                                        ScheduledJobStatus status)

Deprecated. since 7.18. To be removed in 8.0. Use saveScheduledJobStatus(JobId, ScheduledJobStatus)

Stores the status for the specified job.

Parameters:

key - the job key

status - stores the job status.

saveScheduledJobStatus

default void saveScheduledJobStatus(com.atlassian.scheduler.config.JobId jobId,
                                    ScheduledJobStatus status)

updateStatus

@Deprecated
void updateStatus(ScheduledJobKey key,
                              ExecutionStatus status)

Deprecated. since 7.18. To be removed in 8.0. Use updateStatus(JobId, ExecutionStatus)

Updates the status in the corresponding ScheduledJobStatus for the job.

{link #saveScheduledJobStatus} should be called first, otherwise the update will be ignored.

updateStatus

default void updateStatus(com.atlassian.scheduler.config.JobId jobId,
                          ExecutionStatus status)

addHistory

@Deprecated
void addHistory(ScheduledJobKey key,
                            @Nullable ScheduledJobHistory history,
                            Date nextOccurrence)

Deprecated. since 7.18. To be removed in 8.0. Use addHistory(JobId, ScheduledJobHistory, Date)

Adds to an event to the history to the cache, and updates the nextOccurrence in the ScheduledJobStatus.

Parameters:

key - the job key

history - the event that occurred

nextOccurrence - the date that the job is expected to execute next

addHistory

default void addHistory(com.atlassian.scheduler.config.JobId jobId,
                        @Nullable ScheduledJobHistory history,
                        Date nextOccurrence)

updateNextOccurence

@Deprecated
void updateNextOccurence(ScheduledJobKey key,
                                     Date nextOccurence)

Deprecated. since 7.18. To be removed in 8.0. Use updateNextOccurrence(JobId, Date)

Updates the nextOccurence in the ScheduledJobStatus.

Parameters:

key - the job key

nextOccurence - the date that the job is expected to execute next

updateNextOccurrence

default void updateNextOccurrence(com.atlassian.scheduler.config.JobId jobId,
                                  Date nextOccurrence)

saveScheduledJobConfiguration

@Deprecated
void saveScheduledJobConfiguration(ScheduledJobKey key,
                                               ScheduledJobConfiguration jobConfiguration)

Deprecated. since 7.18. To be removed in 8.0. Use saveScheduledJobConfiguration(JobId, ScheduledJobConfiguration)

Stores the job configuration.

Parameters:

key - the job key

jobConfiguration - the configuration

saveScheduledJobConfiguration

default void saveScheduledJobConfiguration(com.atlassian.scheduler.config.JobId jobId,
                                           ScheduledJobConfiguration jobConfiguration)

getScheduledJobConfiguration

@Deprecated
@Nullable ScheduledJobConfiguration getScheduledJobConfiguration(ScheduledJobKey key)

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

Gets the job configuration for the specified job.

Parameters:

key - the job key

Returns:

null if not found.

getScheduledJobConfiguration

default @Nullable ScheduledJobConfiguration getScheduledJobConfiguration(com.atlassian.scheduler.config.JobId jobId)