Package cn.boboweike.carrot.storage.nosql.mongo

Class MongoDBPartitionedStorageProvider

java.lang.Object

cn.boboweike.carrot.storage.AbstractPartitionedStorageProvider

cn.boboweike.carrot.storage.nosql.mongo.MongoDBPartitionedStorageProvider

All Implemented Interfaces:

PartitionedStorageProvider, AutoCloseable

public class MongoDBPartitionedStorageProvider
extends AbstractPartitionedStorageProvider
implements PartitionedStorageProvider

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DB_NAME

Fields inherited from interface cn.boboweike.carrot.storage.PartitionedStorageProvider

BATCH_SIZE, DEFAULT_NUM_OF_PARTITIONS, PARTITION_HINT_KEY, PARTITION_PREFIX

Constructor Summary

Constructors

Constructor	Description
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, RateLimiter changeListenerNotificationRateLimit, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, StorageProviderUtils.DatabaseOptions databaseOptions, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix, StorageProviderUtils.DatabaseOptions databaseOptions, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient, String dbName, String collectionPrefix, StorageProviderUtils.DatabaseOptions databaseOptions, RateLimiter changeListenerNotificationRateLimit, int totalNumOfPartitions)
MongoDBPartitionedStorageProvider(String connectionString)
MongoDBPartitionedStorageProvider(String connectionString, int totalNumOfPartitions)

Method Summary

Modifier and Type	Method	Description
void	announceBackgroundTaskServer(BackgroundTaskServerStatus serverStatus)
long	countRecurringTasksByPartition(Integer partition)
void	deleteMetadata(String name)
int	deletePermanentlyByPartition(UUID id, Integer partition)
int	deleteRecurringTask(String id)
int	deleteTasksPermanentlyByPartition(StateName state, Instant updatedBefore, Integer partition)
boolean	existsByPartition(TaskDetails taskDetails, Integer partition, StateName... states)
boolean	extendLockByPartition(Integer partition, int durationInSeconds, String lockedBy)
List<BackgroundTaskServerStatus>	getBackgroundTaskServers()
Set<String>	getDistinctTaskSignatures(StateName... states)
UUID	getLongestRunningBackgroundTaskServerId()
List<CarrotMetadata>	getMetadata(String name)
CarrotMetadata	getMetadata(String name, String owner)
List<RecurringTask>	getRecurringTasks()
List<RecurringTask>	getRecurringTasksByPartition(Integer partition)
List<Task>	getScheduledTasksByPartition(Instant scheduledBefore, PageRequest pageRequest, Integer partition)
Task	getTaskById(UUID id)
Page<Task>	getTaskPageByPartition(StateName state, PageRequest pageRequest, Integer partition)
List<Task>	getTasksByPartition(StateName state, PageRequest pageRequest, Integer partition)
List<Task>	getTasksByPartition(StateName state, Instant updatedBefore, PageRequest pageRequest, Integer partition)
TaskStatsData	getTaskStatsData()
int	getTotalNumOfPartitions()
boolean	lockByPartition(Integer partition, int durationInSeconds, String lockedBy)
void	publishTotalAmountOfSucceededTasks(int amount)
boolean	recurringTaskExistsByPartition(String recurringTaskId, Integer partition, StateName... states)
int	removeTimedOutBackgroundTaskServers(Instant heartbeatOlderThan)
Task	save(Task task)
List<Task>	save(List<Task> tasks)
Task	saveByPartition(Task task, Integer partition)
List<Task>	saveByPartition(List<Task> tasks, Integer partition)
void	saveMetadata(CarrotMetadata metadata)
RecurringTask	saveRecurringTask(RecurringTask recurringTask)
RecurringTask	saveRecurringTaskByPartition(RecurringTask recurringTask, Integer partition)
void	setPartitioner(Partitioner partitioner)
void	setTaskMapper(TaskMapper taskMapper)
void	setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)	This method allows to reinitialize the StorageProvider.
boolean	signalBackgroundTaskServerAlive(BackgroundTaskServerStatus serverStatus)
void	signalBackgroundTaskServerStopped(BackgroundTaskServerStatus serverStatus)
static String	toMongoId(String id)
boolean	unlockByPartition(Integer partition)

Methods inherited from class cn.boboweike.carrot.storage.AbstractPartitionedStorageProvider

addTaskStorageOnChangeListener, close, getName, notifyMetadataChangeListeners, notifyMetadataChangeListeners, notifyTaskStatsOnChangeListeners, notifyTaskStatsOnChangeListenersIf, removeTaskStorageOnChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.boboweike.carrot.storage.PartitionedStorageProvider

addTaskStorageOnChangeListener, close, getName, getTaskById, removeTaskStorageOnChangeListener

Field Detail

DEFAULT_DB_NAME

public static final String DEFAULT_DB_NAME

See Also:

Constant Field Values

Constructor Detail

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(String connectionString)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(String connectionString,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         String dbName,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         String dbName,
                                         StorageProviderUtils.DatabaseOptions databaseOptions,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         String dbName,
                                         String collectionPrefix,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

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

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         RateLimiter changeListenerNotificationRateLimit,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

public MongoDBPartitionedStorageProvider(com.mongodb.client.MongoClient mongoClient,
                                         StorageProviderUtils.DatabaseOptions databaseOptions,
                                         RateLimiter changeListenerNotificationRateLimit,
                                         int totalNumOfPartitions)

MongoDBPartitionedStorageProvider

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

Method Detail

getTotalNumOfPartitions

public int getTotalNumOfPartitions()

Specified by:

getTotalNumOfPartitions in interface PartitionedStorageProvider

lockByPartition

public boolean lockByPartition(Integer partition,
                               int durationInSeconds,
                               String lockedBy)

Specified by:

lockByPartition in interface PartitionedStorageProvider

extendLockByPartition

public boolean extendLockByPartition(Integer partition,
                                     int durationInSeconds,
                                     String lockedBy)

Specified by:

extendLockByPartition in interface PartitionedStorageProvider

unlockByPartition

public boolean unlockByPartition(Integer partition)

Specified by:

unlockByPartition in interface PartitionedStorageProvider

setTaskMapper

public void setTaskMapper(TaskMapper taskMapper)

Specified by:

setTaskMapper in interface PartitionedStorageProvider

setPartitioner

public void setPartitioner(Partitioner partitioner)

Specified by:

setPartitioner in interface PartitionedStorageProvider

setUpStorageProvider

public void setUpStorageProvider(StorageProviderUtils.DatabaseOptions databaseOptions)

Description copied from interface: PartitionedStorageProvider

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 PartitionedStorageProvider

Parameters:

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

announceBackgroundTaskServer

public void announceBackgroundTaskServer(BackgroundTaskServerStatus serverStatus)

Specified by:

announceBackgroundTaskServer in interface PartitionedStorageProvider

signalBackgroundTaskServerAlive

public boolean signalBackgroundTaskServerAlive(BackgroundTaskServerStatus serverStatus)

Specified by:

signalBackgroundTaskServerAlive in interface PartitionedStorageProvider

signalBackgroundTaskServerStopped

public void signalBackgroundTaskServerStopped(BackgroundTaskServerStatus serverStatus)

Specified by:

signalBackgroundTaskServerStopped in interface PartitionedStorageProvider

getBackgroundTaskServers

public List<BackgroundTaskServerStatus> getBackgroundTaskServers()

Specified by:

getBackgroundTaskServers in interface PartitionedStorageProvider

getLongestRunningBackgroundTaskServerId

public UUID getLongestRunningBackgroundTaskServerId()

Specified by:

getLongestRunningBackgroundTaskServerId in interface PartitionedStorageProvider

removeTimedOutBackgroundTaskServers

public int removeTimedOutBackgroundTaskServers(Instant heartbeatOlderThan)

Specified by:

removeTimedOutBackgroundTaskServers in interface PartitionedStorageProvider

saveMetadata

public void saveMetadata(CarrotMetadata metadata)

Specified by:

saveMetadata in interface PartitionedStorageProvider

getMetadata

public List<CarrotMetadata> getMetadata(String name)

Specified by:

getMetadata in interface PartitionedStorageProvider

getMetadata

public CarrotMetadata getMetadata(String name,
                                  String owner)

Specified by:

getMetadata in interface PartitionedStorageProvider

deleteMetadata

public void deleteMetadata(String name)

Specified by:

deleteMetadata in interface PartitionedStorageProvider

save

public Task save(Task task)

Specified by:

save in interface PartitionedStorageProvider

saveByPartition

public Task saveByPartition(Task task,
                            Integer partition)

Specified by:

saveByPartition in interface PartitionedStorageProvider

deletePermanentlyByPartition

public int deletePermanentlyByPartition(UUID id,
                                        Integer partition)

Specified by:

deletePermanentlyByPartition in interface PartitionedStorageProvider

getTaskById

public Task getTaskById(UUID id)

Specified by:

getTaskById in interface PartitionedStorageProvider

save

public List<Task> save(List<Task> tasks)

Specified by:

save in interface PartitionedStorageProvider

saveByPartition

public List<Task> saveByPartition(List<Task> tasks,
                                  Integer partition)

Specified by:

saveByPartition in interface PartitionedStorageProvider

getTasksByPartition

public List<Task> getTasksByPartition(StateName state,
                                      Instant updatedBefore,
                                      PageRequest pageRequest,
                                      Integer partition)

Specified by:

getTasksByPartition in interface PartitionedStorageProvider

getScheduledTasksByPartition

public List<Task> getScheduledTasksByPartition(Instant scheduledBefore,
                                               PageRequest pageRequest,
                                               Integer partition)

Specified by:

getScheduledTasksByPartition in interface PartitionedStorageProvider

getTasksByPartition

public List<Task> getTasksByPartition(StateName state,
                                      PageRequest pageRequest,
                                      Integer partition)

Specified by:

getTasksByPartition in interface PartitionedStorageProvider

getTaskPageByPartition

public Page<Task> getTaskPageByPartition(StateName state,
                                         PageRequest pageRequest,
                                         Integer partition)

Specified by:

getTaskPageByPartition in interface PartitionedStorageProvider

deleteTasksPermanentlyByPartition

public int deleteTasksPermanentlyByPartition(StateName state,
                                             Instant updatedBefore,
                                             Integer partition)

Specified by:

deleteTasksPermanentlyByPartition in interface PartitionedStorageProvider

getDistinctTaskSignatures

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

Specified by:

getDistinctTaskSignatures in interface PartitionedStorageProvider

existsByPartition

public boolean existsByPartition(TaskDetails taskDetails,
                                 Integer partition,
                                 StateName... states)

Specified by:

existsByPartition in interface PartitionedStorageProvider

recurringTaskExistsByPartition

public boolean recurringTaskExistsByPartition(String recurringTaskId,
                                              Integer partition,
                                              StateName... states)

Specified by:

recurringTaskExistsByPartition in interface PartitionedStorageProvider

saveRecurringTask

public RecurringTask saveRecurringTask(RecurringTask recurringTask)

Specified by:

saveRecurringTask in interface PartitionedStorageProvider

saveRecurringTaskByPartition

public RecurringTask saveRecurringTaskByPartition(RecurringTask recurringTask,
                                                  Integer partition)

getRecurringTasksByPartition

public List<RecurringTask> getRecurringTasksByPartition(Integer partition)

Specified by:

getRecurringTasksByPartition in interface PartitionedStorageProvider

getRecurringTasks

public List<RecurringTask> getRecurringTasks()

Specified by:

getRecurringTasks in interface PartitionedStorageProvider

countRecurringTasksByPartition

public long countRecurringTasksByPartition(Integer partition)

Specified by:

countRecurringTasksByPartition in interface PartitionedStorageProvider

deleteRecurringTask

public int deleteRecurringTask(String id)

Specified by:

deleteRecurringTask in interface PartitionedStorageProvider

getTaskStatsData

public TaskStatsData getTaskStatsData()

Specified by:

getTaskStatsData in interface PartitionedStorageProvider

publishTotalAmountOfSucceededTasks

public void publishTotalAmountOfSucceededTasks(int amount)

Specified by:

publishTotalAmountOfSucceededTasks in interface PartitionedStorageProvider

toMongoId

public static String toMongoId(String id)