Package org.jobrunr.storage.nosql.elasticsearch

Class ElasticSearchStorageProvider

java.lang.Object

org.jobrunr.storage.AbstractStorageProvider

org.jobrunr.storage.nosql.elasticsearch.ElasticSearchStorageProvider

All Implemented Interfaces:

AutoCloseable, NoSqlStorageProvider, StorageProvider

@Beta(note="The ElasticSearchStorageProvider is still in Beta. My first impression is that other StorageProviders are faster than ElasticSearch.")
public class ElasticSearchStorageProvider
extends AbstractStorageProvider
implements NoSqlStorageProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.jobrunr.storage.StorageProvider

StorageProvider.StorageProviderInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BACKGROUND_JOB_SERVER_INDEX_NAME
static final String	DEFAULT_JOB_INDEX_NAME
static final String	DEFAULT_METADATA_INDEX_NAME
static final String	DEFAULT_RECURRING_JOB_INDEX_NAME
static final int	MAX_SIZE

Fields inherited from interface org.jobrunr.storage.StorageProvider

BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
ElasticSearchStorageProvider(String hostName, int port)
ElasticSearchStorageProvider(org.apache.http.HttpHost httpHost)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client, String indexPrefix)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client, String indexPrefix, StorageProviderUtils.DatabaseOptions databaseOptions)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client, String indexPrefix, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client, StorageProviderUtils.DatabaseOptions databaseOptions)
ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter rateLimiter)

Method Summary

Modifier and Type	Method	Description
void	announceBackgroundJobServer(BackgroundJobServerStatus status)
long	countRecurringJobs()
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)
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)
void	publishTotalAmountOfSucceededJobs(int amount)
boolean	recurringJobExists(String recurringJobId, StateName... states)
boolean	recurringJobsUpdated(Long recurringJobsUpdatedHash)
int	removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)
List<Job>	save(List<Job> jobs)
Job	save(Job job)
void	saveMetadata(JobRunrMetadata metadata)
RecurringJob	saveRecurringJob(RecurringJob job)
void	setJobMapper(JobMapper jobMapper)
void	setUpStorageProvider(StorageProviderUtils.DatabaseOptions options)	This method allows to reinitialize the StorageProvider.
boolean	signalBackgroundJobServerAlive(BackgroundJobServerStatus status)
void	signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Methods inherited from class org.jobrunr.storage.AbstractStorageProvider

addJobStorageOnChangeListener, close, getStorageProviderInfo, notifyJobStatsOnChangeListeners, notifyJobStatsOnChangeListenersIf, notifyMetadataChangeListeners, notifyMetadataChangeListeners, removeJobStorageOnChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jobrunr.storage.StorageProvider

addJobStorageOnChangeListener, close, getJobById, getStorageProviderInfo, removeJobStorageOnChangeListener

Field Details

DEFAULT_JOB_INDEX_NAME

public static final String DEFAULT_JOB_INDEX_NAME

See Also:

• Constant Field Values

DEFAULT_RECURRING_JOB_INDEX_NAME

public static final String DEFAULT_RECURRING_JOB_INDEX_NAME

See Also:

• Constant Field Values

DEFAULT_BACKGROUND_JOB_SERVER_INDEX_NAME

public static final String DEFAULT_BACKGROUND_JOB_SERVER_INDEX_NAME

See Also:

• Constant Field Values

DEFAULT_METADATA_INDEX_NAME

public static final String DEFAULT_METADATA_INDEX_NAME

See Also:

• Constant Field Values

MAX_SIZE

public static final int MAX_SIZE

See Also:

• Constant Field Values

Constructor Details

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(String hostName,
 int port)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.apache.http.HttpHost httpHost)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client,
 String indexPrefix)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client,
 String indexPrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client,
 StorageProviderUtils.DatabaseOptions databaseOptions)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter rateLimiter)

ElasticSearchStorageProvider

public ElasticSearchStorageProvider(org.elasticsearch.client.RestHighLevelClient client,
 String indexPrefix,
 StorageProviderUtils.DatabaseOptions databaseOptions,
 RateLimiter changeListenerNotificationRateLimit)

Method Details

setJobMapper

public void setJobMapper(JobMapper jobMapper)

Specified by:

setJobMapper in interface StorageProvider

setUpStorageProvider

public void setUpStorageProvider(StorageProviderUtils.DatabaseOptions options)

Description copied from interface: StorageProvider

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

Specified by:

setUpStorageProvider in interface StorageProvider

Parameters:

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

announceBackgroundJobServer

public void announceBackgroundJobServer(BackgroundJobServerStatus status)

Specified by:

announceBackgroundJobServer in interface StorageProvider

signalBackgroundJobServerAlive

public boolean signalBackgroundJobServerAlive(BackgroundJobServerStatus status)

Specified by:

signalBackgroundJobServerAlive in interface StorageProvider

signalBackgroundJobServerStopped

public void signalBackgroundJobServerStopped(BackgroundJobServerStatus serverStatus)

Specified by:

signalBackgroundJobServerStopped in interface StorageProvider

getBackgroundJobServers

public List<BackgroundJobServerStatus> getBackgroundJobServers()

Specified by:

getBackgroundJobServers in interface StorageProvider

getLongestRunningBackgroundJobServerId

public UUID getLongestRunningBackgroundJobServerId()

Specified by:

getLongestRunningBackgroundJobServerId in interface StorageProvider

removeTimedOutBackgroundJobServers

public int removeTimedOutBackgroundJobServers(Instant heartbeatOlderThan)

Specified by:

removeTimedOutBackgroundJobServers in interface StorageProvider

saveMetadata

public void saveMetadata(JobRunrMetadata metadata)

Specified by:

saveMetadata in interface StorageProvider

getMetadata

public List<JobRunrMetadata> getMetadata(String name)

Specified by:

getMetadata in interface StorageProvider

getMetadata

public JobRunrMetadata getMetadata(String name,
 String owner)

Specified by:

getMetadata in interface StorageProvider

deleteMetadata

public void deleteMetadata(String name)

Specified by:

deleteMetadata in interface StorageProvider

save

public Job save(Job job)

Specified by:

save in interface StorageProvider

deletePermanently

public int deletePermanently(UUID id)

Specified by:

deletePermanently in interface StorageProvider

getJobById

public Job getJobById(UUID id)

Specified by:

getJobById in interface StorageProvider

save

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

Specified by:

save in interface StorageProvider

getJobs

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

Specified by:

getJobs in interface StorageProvider

getScheduledJobs

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

Specified by:

getScheduledJobs in interface StorageProvider

getJobs

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

Specified by:

getJobs in interface StorageProvider

getJobPage

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

Specified by:

getJobPage in interface StorageProvider

deleteJobsPermanently

public int deleteJobsPermanently(StateName state,
 Instant updatedBefore)

Specified by:

deleteJobsPermanently in interface StorageProvider

getDistinctJobSignatures

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

Specified by:

getDistinctJobSignatures in interface StorageProvider

exists

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

Specified by:

exists in interface StorageProvider

recurringJobExists

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

Specified by:

recurringJobExists in interface StorageProvider

saveRecurringJob

public RecurringJob saveRecurringJob(RecurringJob job)

Specified by:

saveRecurringJob in interface StorageProvider

getRecurringJobs

public RecurringJobsResult getRecurringJobs()

Specified by:

getRecurringJobs in interface StorageProvider

recurringJobsUpdated

public boolean recurringJobsUpdated(Long recurringJobsUpdatedHash)

Specified by:

recurringJobsUpdated in interface StorageProvider

countRecurringJobs

public long countRecurringJobs()

Specified by:

countRecurringJobs in interface StorageProvider

deleteRecurringJob

public int deleteRecurringJob(String id)

Specified by:

deleteRecurringJob in interface StorageProvider

getJobStats

public JobStats getJobStats()

Specified by:

getJobStats in interface StorageProvider

publishTotalAmountOfSucceededJobs

public void publishTotalAmountOfSucceededJobs(int amount)

Specified by:

publishTotalAmountOfSucceededJobs in interface StorageProvider