Package cn.boboweike.carrot.storage

Interface PartitionedStorageProvider

All Known Implementing Classes:

AbstractPartitionedStorageProvider, InMemoryPartitionedStorageProvider, MongoDBPartitionedStorageProvider, ThreadSafePartitionedStorageProvider

public interface PartitionedStorageProvider

Field Summary

Fields

Modifier and Type	Field	Description
static int	BATCH_SIZE
static int	DEFAULT_NUM_OF_PARTITIONS
static String	PARTITION_HINT_KEY
static String	PARTITION_PREFIX

Method Summary

Modifier and Type	Method	Description
void	addTaskStorageOnChangeListener(StorageProviderChangeListener listener)
void	announceBackgroundTaskServer(BackgroundTaskServerStatus serverStatus)
void	close()
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)
String	getName()
List<RecurringTask>	getRecurringTasks()
List<RecurringTask>	getRecurringTasksByPartition(Integer partition)
List<Task>	getScheduledTasksByPartition(Instant scheduledBefore, PageRequest pageRequest, Integer partition)
default Task	getTaskById(TaskId taskId)
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)
void	removeTaskStorageOnChangeListener(StorageProviderChangeListener listener)
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)
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)
boolean	unlockByPartition(Integer partition)

Field Detail

BATCH_SIZE

static final int BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_NUM_OF_PARTITIONS

static final int DEFAULT_NUM_OF_PARTITIONS

See Also:

Constant Field Values

PARTITION_PREFIX

static final String PARTITION_PREFIX

See Also:

Constant Field Values

PARTITION_HINT_KEY

static final String PARTITION_HINT_KEY

See Also:

Constant Field Values

Method Detail

getName

String getName()

getTotalNumOfPartitions

int getTotalNumOfPartitions()

lockByPartition

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

extendLockByPartition

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

unlockByPartition

boolean unlockByPartition(Integer partition)

setTaskMapper

void setTaskMapper(TaskMapper taskMapper)

setPartitioner

void setPartitioner(Partitioner partitioner)

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.

addTaskStorageOnChangeListener

void addTaskStorageOnChangeListener(StorageProviderChangeListener listener)

removeTaskStorageOnChangeListener

void removeTaskStorageOnChangeListener(StorageProviderChangeListener listener)

announceBackgroundTaskServer

void announceBackgroundTaskServer(BackgroundTaskServerStatus serverStatus)

signalBackgroundTaskServerAlive

boolean signalBackgroundTaskServerAlive(BackgroundTaskServerStatus serverStatus)

signalBackgroundTaskServerStopped

void signalBackgroundTaskServerStopped(BackgroundTaskServerStatus serverStatus)

getBackgroundTaskServers

List<BackgroundTaskServerStatus> getBackgroundTaskServers()

getLongestRunningBackgroundTaskServerId

UUID getLongestRunningBackgroundTaskServerId()

removeTimedOutBackgroundTaskServers

int removeTimedOutBackgroundTaskServers(Instant heartbeatOlderThan)

saveMetadata

void saveMetadata(CarrotMetadata metadata)

getMetadata

List<CarrotMetadata> getMetadata(String name)

getMetadata

CarrotMetadata getMetadata(String name,
                           String owner)

deleteMetadata

void deleteMetadata(String name)

save

Task save(Task task)

saveByPartition

Task saveByPartition(Task task,
                     Integer partition)

deletePermanentlyByPartition

int deletePermanentlyByPartition(UUID id,
                                 Integer partition)

getTaskById

Task getTaskById(UUID id)

save

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

saveByPartition

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

getTasksByPartition

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

getScheduledTasksByPartition

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

getTasksByPartition

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

getTaskPageByPartition

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

deleteTasksPermanentlyByPartition

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

getDistinctTaskSignatures

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

existsByPartition

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

recurringTaskExistsByPartition

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

saveRecurringTask

RecurringTask saveRecurringTask(RecurringTask recurringTask)

getRecurringTasksByPartition

List<RecurringTask> getRecurringTasksByPartition(Integer partition)

getRecurringTasks

List<RecurringTask> getRecurringTasks()

countRecurringTasksByPartition

long countRecurringTasksByPartition(Integer partition)

deleteRecurringTask

int deleteRecurringTask(String id)

getTaskStatsData

TaskStatsData getTaskStatsData()

publishTotalAmountOfSucceededTasks

void publishTotalAmountOfSucceededTasks(int amount)

getTaskById

default Task getTaskById(TaskId taskId)

close

void close()