Package org.jobrunr.storage

Interface StorageProvider

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

NoSqlStorageProvider, SqlStorageProvider

All Known Implementing Classes:

AbstractStorageProvider, AmazonDocumentDBStorageProvider, DB2StorageProvider, DefaultSqlStorageProvider, ElasticSearchStorageProvider, H2StorageProvider, InMemoryStorageProvider, JedisRedisStorageProvider, LettuceRedisStorageProvider, MariaDbStorageProvider, MongoDBStorageProvider, MySqlStorageProvider, OracleStorageProvider, PostgresStorageProvider, SqLiteStorageProvider, SQLServerStorageProvider, ThreadSafeStorageProvider

public interface StorageProvider
extends AutoCloseable

The StorageProvider allows to store, retrieve and delete background jobs. This API is public and JobRunr major version will change of this StorageProvider API changes.

Since:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StorageProvider.StorageProviderInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATCH_SIZE

Method Summary

Modifier and Type	Method	Description
void	addJobStorageOnChangeListener(StorageProviderChangeListener listener)
void	announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)
void	close()
long	countRecurringJobs()	Deprecated.
int	deleteJobsPermanently(StateName state, Instant updatedBefore)
void	deleteMetadata(String name)
int	deletePermanently(UUID id)
int	deleteRecurringJob(String id)
boolean	exists(JobDetails jobDetails, StateName... states)
List<BackgroundJobServerStatus>	getBackgroundJobServers()
Set<String>	getDistinctJobSignatures(StateName... states)
Job	getJobById(UUID id)
default Job	getJobById(JobId jobId)
Page<Job>	getJobPage(StateName state, PageRequest pageRequest)
List<Job>	getJobs(StateName state, Instant updatedBefore, PageRequest pageRequest)
List<Job>	getJobs(StateName state, PageRequest pageRequest)
JobStats	getJobStats()
UUID	getLongestRunningBackgroundJobServerId()
List<JobRunrMetadata>	getMetadata(String name)
JobRunrMetadata	getMetadata(String name, String owner)
RecurringJobsResult	getRecurringJobs()
List<Job>	getScheduledJobs(Instant scheduledBefore, PageRequest pageRequest)
StorageProvider.StorageProviderInfo	getStorageProviderInfo()
void	publishTotalAmountOfSucceededJobs(int amount)
boolean	recurringJobExists(String recurringJobId, StateName... states)
boolean	recurringJobsUpdated(Long recurringJobsUpdatedHash)
void	removeJobStorageOnChangeListener(StorageProviderChangeListener listener)
int	removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)
List<Job>	save(List<Job> jobs)
Job	save(Job job)
void	saveMetadata(JobRunrMetadata metadata)
RecurringJob	saveRecurringJob(RecurringJob recurringJob)
void	setJobMapper(JobMapper jobMapper)
void	setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)	This method allows to reinitialize the StorageProvider.
boolean	signalBackgroundJobServerAlive(BackgroundJobServerStatus serverStatus)
void	signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Field Details

BATCH_SIZE

static final int BATCH_SIZE

See Also:

• Constant Field Values

Method Details

getStorageProviderInfo

StorageProvider.StorageProviderInfo getStorageProviderInfo()

setJobMapper

void setJobMapper(JobMapper jobMapper)

setUpStorageProvider

void setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)

This method allows to reinitialize the StorageProvider. It can be used if you are using Flyway or Liquibase to setup your database manually. By default, this method is automatically called on construction of the StorageProvider

Parameters:

databaseOptions - defines whether to set up the StorageProvider or validate whether the StorageProvider is set up correctly.

addJobStorageOnChangeListener

void addJobStorageOnChangeListener(StorageProviderChangeListener listener)

removeJobStorageOnChangeListener

void removeJobStorageOnChangeListener(StorageProviderChangeListener listener)

announceBackgroundJobServer

void announceBackgroundJobServer(BackgroundJobServerStatus serverStatus)

signalBackgroundJobServerAlive

boolean signalBackgroundJobServerAlive(BackgroundJobServerStatus serverStatus)

signalBackgroundJobServerStopped

void signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

getBackgroundJobServers

List<BackgroundJobServerStatus> getBackgroundJobServers()

getLongestRunningBackgroundJobServerId

UUID getLongestRunningBackgroundJobServerId()

removeTimedOutBackgroundJobServers

int removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)

saveMetadata

void saveMetadata(JobRunrMetadata metadata)

getMetadata

List<JobRunrMetadata> getMetadata(String name)

getMetadata

JobRunrMetadata getMetadata(String name,
 String owner)

deleteMetadata

void deleteMetadata(String name)

save

Job save(Job job)

deletePermanently

int deletePermanently(UUID id)

getJobById

Job getJobById(UUID id)

save

List<Job> save(List<Job> jobs)

getJobs

List<Job> getJobs(StateName state,
 Instant updatedBefore,
 PageRequest pageRequest)

getScheduledJobs

List<Job> getScheduledJobs(Instant scheduledBefore,
 PageRequest pageRequest)

getJobs

List<Job> getJobs(StateName state,
 PageRequest pageRequest)

getJobPage

Page<Job> getJobPage(StateName state,
 PageRequest pageRequest)

deleteJobsPermanently

int deleteJobsPermanently(StateName state,
 Instant updatedBefore)

getDistinctJobSignatures

Set<String> getDistinctJobSignatures(StateName... states)

exists

boolean exists(JobDetails jobDetails,
 StateName... states)

recurringJobExists

boolean recurringJobExists(String recurringJobId,
 StateName... states)

saveRecurringJob

RecurringJob saveRecurringJob(RecurringJob recurringJob)

countRecurringJobs

@Deprecated
long countRecurringJobs()

Deprecated.

getRecurringJobs

RecurringJobsResult getRecurringJobs()

recurringJobsUpdated

boolean recurringJobsUpdated(Long recurringJobsUpdatedHash)

deleteRecurringJob

int deleteRecurringJob(String id)

getJobStats

JobStats getJobStats()

publishTotalAmountOfSucceededJobs

void publishTotalAmountOfSucceededJobs(int amount)

getJobById

default Job getJobById(JobId jobId)

close

void close()

Specified by:

close in interface AutoCloseable