Class AbstractStorageProvider

java.lang.Object

org.jobrunr.storage.AbstractStorageProvider

All Implemented Interfaces:

AutoCloseable, StorageProvider

Direct Known Subclasses:

DefaultSqlStorageProvider, InMemoryStorageProvider, MongoDBStorageProvider

public abstract class AbstractStorageProvider
extends Object
implements StorageProvider, AutoCloseable

Nested Class Summary

Nested classes/interfaces inherited from interface StorageProvider

StorageProvider.StorageProviderInfo

Modifier and Type	Interface	Description
static class	StorageProvider.StorageProviderInfo

Field Summary

Fields inherited from interface StorageProvider

BATCH_SIZE

Modifier and Type	Field	Description
static final int	BATCH_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStorageProvider(RateLimiter changeListenerNotificationRateLimit)

Method Summary

Modifier and Type	Method	Description
void	addJobStorageOnChangeListener(StorageProviderChangeListener listener)	Allows to listen for changes related to jobs.
void	close()
StorageProvider.StorageProviderInfo	getStorageProviderInfo()
protected void	notifyJobStatsOnChangeListeners()
protected void	notifyJobStatsOnChangeListenersIf(boolean mustNotify)
protected void	notifyMetadataChangeListeners()
protected void	notifyMetadataChangeListenersIf(boolean mustNotify)
protected void	notifyMetadataChangeListenersOnCurrentThread()
void	removeJobStorageOnChangeListener(StorageProviderChangeListener listener)	Remove the given listener that listens for changes to Jobs
final void	validatePollInterval(Duration pollInterval)
final void	validateRecurringJobInterval(Duration durationBetweenRecurringJobInstances)

Methods inherited from class Object

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

Methods inherited from interface StorageProvider

announceBackgroundJobServer, countJobs, deleteJobsPermanently, deleteMetadata, deleteMetadata, deletePermanently, deleteRecurringJob, getBackgroundJobServers, getCarbonAwareJobList, getDistinctJobSignatures, getJobById, getJobById, getJobList, getJobList, getJobs, getJobStats, getJobsToProcess, getLongestRunningBackgroundJobServerId, getMetadata, getMetadata, getRecurringJobLatestScheduledInstant, getRecurringJobs, getScheduledJobs, getScheduledJobs, publishTotalAmountOfSucceededJobs, recurringJobsUpdated, removeTimedOutBackgroundJobServers, save, save, saveMetadata, saveRecurringJob, setJobMapper, setUpStorageProvider, signalBackgroundJobServerAlive, signalBackgroundJobServerStopped

Modifier and Type	Method	Description
void	announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)
long	countJobs(StateName state)	Counts all the jobs matching the given StateName.
int	deleteJobsPermanently(StateName state, Instant updatedBefore)
void	deleteMetadata(String name)
void	deleteMetadata(String name, String owner)
int	deletePermanently(UUID id)	Deletes the Job with the given id and returns the amount of deleted jobs (either 0 or 1).
int	deleteRecurringJob(String id)	Deletes the RecurringJob with the given id.
List<BackgroundJobServerStatus>	getBackgroundJobServers()
List<Job>	getCarbonAwareJobList(Instant deadlineBefore, AmountRequest amountRequest)	Returns all carbon aware jobs with a deadline before the given Instant.
Set<String>	getDistinctJobSignatures(StateName... states)
Job	getJobById(UUID id)	Returns the Job with the given id or throws a JobNotFoundException if the job does not exist
default Job	getJobById(JobId jobId)	Returns the Job with the given id or throws a JobNotFoundException if the job does not exist
List<Job>	getJobList(StateName state, Instant updatedBefore, AmountRequest amountRequest)	Returns all the jobs matching the given StateName, Instant and AmountRequest.
List<Job>	getJobList(StateName state, AmountRequest amountRequest)	Returns all the jobs matching the given StateName and AmountRequest.
default Page<Job>	getJobs(StateName state, PageRequest pageRequest)
JobStats	getJobStats()	Returns the statistics of the jobs (amount enqueued, amount scheduled, ...) Important: in most cases, this results in a intensive query.
default List<Job>	getJobsToProcess(BackgroundJobServer backgroundJobServer, AmountRequest amountRequest)
UUID	getLongestRunningBackgroundJobServerId()
List<JobRunrMetadata>	getMetadata(String name)
JobRunrMetadata	getMetadata(String name, String owner)
Instant	getRecurringJobLatestScheduledInstant(String recurringJobId, StateName... states)	Returns the scheduled instant of the last Job, in one of the given states, created by the RecurringJob with the given recurringJobId.
RecurringJobsResult	getRecurringJobs()	Returns a list RecurringJobs.
List<Job>	getScheduledJobs(Instant scheduledBefore, AmountRequest amountRequest)
default Page<Job>	getScheduledJobs(Instant scheduledBefore, PageRequest pageRequest)
void	publishTotalAmountOfSucceededJobs(int amount)
boolean	recurringJobsUpdated(Long recurringJobsUpdatedHash)
int	removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)
List<Job>	save(List<Job> jobs)	Saves a list of Jobs and increases the version of each successfully saved Job.
Job	save(Job job)	Save the Job and increases the version if saving succeeded.
void	saveMetadata(JobRunrMetadata metadata)
RecurringJob	saveRecurringJob(RecurringJob recurringJob)	Saves a RecurringJob to the database.
void	setJobMapper(JobMapper jobMapper)
void	setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)	This method allows to reinitialize the StorageProvider.
boolean	signalBackgroundJobServerAlive(BackgroundJobServerStatus serverStatus)
void	signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Constructor Details

AbstractStorageProvider

protected AbstractStorageProvider(RateLimiter changeListenerNotificationRateLimit)

Method Details

getStorageProviderInfo

public StorageProvider.StorageProviderInfo getStorageProviderInfo()

Specified by:

getStorageProviderInfo in interface StorageProvider

addJobStorageOnChangeListener

public void addJobStorageOnChangeListener(StorageProviderChangeListener listener)

Description copied from interface: StorageProvider

Allows to listen for changes related to jobs.

Specified by:

addJobStorageOnChangeListener in interface StorageProvider

Parameters:

listener - the listener to notify if there are any changes.

See Also:

• JobChangeListener
• JobStatsChangeListener

removeJobStorageOnChangeListener

public void removeJobStorageOnChangeListener(StorageProviderChangeListener listener)

Description copied from interface: StorageProvider

Remove the given listener that listens for changes to Jobs

Specified by:

removeJobStorageOnChangeListener in interface StorageProvider

Parameters:

listener - the listener to remove

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface StorageProvider

validatePollInterval

public final void validatePollInterval(Duration pollInterval)

Specified by:

validatePollInterval in interface StorageProvider

validateRecurringJobInterval

public final void validateRecurringJobInterval(Duration durationBetweenRecurringJobInstances)

Specified by:

validateRecurringJobInterval in interface StorageProvider

notifyJobStatsOnChangeListenersIf

protected void notifyJobStatsOnChangeListenersIf(boolean mustNotify)

notifyJobStatsOnChangeListeners

protected void notifyJobStatsOnChangeListeners()

notifyMetadataChangeListenersIf

protected void notifyMetadataChangeListenersIf(boolean mustNotify)

notifyMetadataChangeListeners

protected void notifyMetadataChangeListeners()

notifyMetadataChangeListenersOnCurrentThread

protected void notifyMetadataChangeListenersOnCurrentThread()