Class AmazonDocumentDBStorageProvider

java.lang.Object

org.jobrunr.storage.AbstractStorageProvider

org.jobrunr.storage.nosql.mongo.MongoDBStorageProvider

org.jobrunr.storage.nosql.documentdb.AmazonDocumentDBStorageProvider

All Implemented Interfaces:

AutoCloseable, NoSqlStorageProvider, StorageProvider

public class AmazonDocumentDBStorageProvider
extends MongoDBStorageProvider

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 class MongoDBStorageProvider

DEFAULT_DB_NAME

Modifier and Type	Field	Description
static final String	DEFAULT_DB_NAME

Fields inherited from interface StorageProvider

BATCH_SIZE

Modifier and Type	Field	Description
static final int	BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix, StorageProviderUtils.DatabaseOptions databaseOptions)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, StorageProviderUtils.DatabaseOptions databaseOptions)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit)
AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient, RateLimiter changeListenerNotificationRateLimit)
AmazonDocumentDBStorageProvider(String hostName, int port)

Method Summary

Modifier and Type	Method	Description
static AmazonDocumentDBStorageProvider	amazonDocumentDBStorageProviderWithDefaultSetting(String hostName, int port, com.mongodb.MongoCredential credential)
static AmazonDocumentDBStorageProvider	amazonDocumentDBStorageProviderWithDefaultSetting(String hostName, int port, com.mongodb.MongoCredential credential, String dbName)
protected void	runMigrations(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix)
protected void	validateTables(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix)

Methods inherited from class MongoDBStorageProvider

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

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.
protected void	explainAggregation(List<org.bson.conversions.Bson> query, String collectionName)	used to perform query analysis for performance tuning
protected void	explainQuery(org.bson.conversions.Bson query)	used to perform query analysis for performance tuning
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
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.
JobStats	getJobStats()	Returns the statistics of the jobs (amount enqueued, amount scheduled, ...) Important: in most cases, this results in a intensive query.
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)
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)
static String	toMongoId(String id)

Methods inherited from class AbstractStorageProvider

addJobStorageOnChangeListener, close, getStorageProviderInfo, notifyJobStatsOnChangeListeners, notifyJobStatsOnChangeListenersIf, notifyMetadataChangeListeners, notifyMetadataChangeListenersIf, notifyMetadataChangeListenersOnCurrentThread, removeJobStorageOnChangeListener, validatePollInterval, validateRecurringJobInterval

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

getJobById, getJobs, getJobsToProcess, getScheduledJobs

Modifier and Type	Method	Description
default Job	getJobById(JobId jobId)	Returns the Job with the given id or throws a JobNotFoundException if the job does not exist
default Page<Job>	getJobs(StateName state, PageRequest pageRequest)
default List<Job>	getJobsToProcess(BackgroundJobServer backgroundJobServer, AmountRequest amountRequest)
default Page<Job>	getScheduledJobs(Instant scheduledBefore, PageRequest pageRequest)

Constructor Details

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(String hostName,
 int port)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 String dbName)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 StorageProviderUtils.DatabaseOptions databaseOptions)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 String collectionPrefix)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 String collectionPrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 RateLimiter changeListenerNotificationRateLimit)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter changeListenerNotificationRateLimit)

AmazonDocumentDBStorageProvider

public AmazonDocumentDBStorageProvider(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 String collectionPrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter changeListenerNotificationRateLimit)

Method Details

runMigrations

protected void runMigrations(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 String collectionPrefix)

Overrides:

runMigrations in class MongoDBStorageProvider

validateTables

protected void validateTables(com.mongodb.client.MongoClient mongoClient,
 String dbName,
 String collectionPrefix)

Overrides:

validateTables in class MongoDBStorageProvider

amazonDocumentDBStorageProviderWithDefaultSetting

public static AmazonDocumentDBStorageProvider amazonDocumentDBStorageProviderWithDefaultSetting(String hostName,
 int port,
 com.mongodb.MongoCredential credential)

amazonDocumentDBStorageProviderWithDefaultSetting

public static AmazonDocumentDBStorageProvider amazonDocumentDBStorageProviderWithDefaultSetting(String hostName,
 int port,
 com.mongodb.MongoCredential credential,
 String dbName)