Package org.dataloader.registries

Class ScheduledDataLoaderRegistry

java.lang.Object

org.dataloader.DataLoaderRegistry

org.dataloader.registries.ScheduledDataLoaderRegistry

All Implemented Interfaces:

java.lang.AutoCloseable

@ExperimentalApi
public class ScheduledDataLoaderRegistry
extends DataLoaderRegistry
implements java.lang.AutoCloseable

This DataLoaderRegistry will use a DispatchPredicate when dispatchAll() is called to test (for each DataLoader in the registry) if a dispatch should proceed. If the predicate returns false, then a task is scheduled to perform that predicate dispatch again via the ScheduledExecutorService.

This will continue to loop (test false and reschedule) until such time as the predicate returns true, in which case no rescheduling will occur and you will need to call dispatch again to restart the process.

If you wanted to create a ScheduledDataLoaderRegistry that started a rescheduling immediately, just create one and call rescheduleNow().

This code is currently marked as ExperimentalApi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduledDataLoaderRegistry.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed
private DispatchPredicate	dispatchPredicate
private java.time.Duration	schedule
private java.util.concurrent.ScheduledExecutorService	scheduledExecutorService

Fields inherited from class org.dataloader.DataLoaderRegistry

dataLoaders

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ScheduledDataLoaderRegistry(ScheduledDataLoaderRegistry.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	close()	Once closed this registry will never again reschedule checks
void	dispatchAll()	This will called DataLoader.dispatch() on each of the registered DataLoaders
void	dispatchAllImmediately()	This will immediately dispatch the DataLoaders in the registry without testing the predicate
int	dispatchAllWithCount()	Similar to DataLoaderRegistry.dispatchAll(), this calls DataLoader.dispatch() on each of the registered DataLoaders, but returns the number of dispatches.
int	dispatchAllWithCountImmediately()	This will immediately dispatch the DataLoaders in the registry without testing the predicate
private void	dispatchOrReschedule(java.lang.String key, DataLoader<?,?> dataLoader)
java.time.Duration	getScheduleDuration()
static ScheduledDataLoaderRegistry.Builder	newScheduledRegistry()	By default this will create use a Executors.newSingleThreadScheduledExecutor() and a schedule duration of 10 milli seconds.
private void	reschedule(java.lang.String key, DataLoader<?,?> dataLoader)
void	rescheduleNow()	This will schedule a task to check the predicate and dispatch if true right now.

Methods inherited from class org.dataloader.DataLoaderRegistry

combine, computeIfAbsent, dispatchDepth, getDataLoader, getDataLoaders, getDataLoadersMap, getKeys, getStatistics, newRegistry, register, unregister

Methods inherited from class java.lang.Object

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

Field Detail

scheduledExecutorService

private final java.util.concurrent.ScheduledExecutorService scheduledExecutorService

dispatchPredicate

private final DispatchPredicate dispatchPredicate

schedule

private final java.time.Duration schedule

closed

private volatile boolean closed

Constructor Detail

ScheduledDataLoaderRegistry

private ScheduledDataLoaderRegistry(ScheduledDataLoaderRegistry.Builder builder)

Method Detail

close

public void close()

Once closed this registry will never again reschedule checks

Specified by:

close in interface java.lang.AutoCloseable

getScheduleDuration

public java.time.Duration getScheduleDuration()

Returns:

how long the ScheduledExecutorService task will wait before checking the predicate again

dispatchAll

public void dispatchAll()

Description copied from class: DataLoaderRegistry

This will called DataLoader.dispatch() on each of the registered DataLoaders

Overrides:

dispatchAll in class DataLoaderRegistry

dispatchAllWithCount

public int dispatchAllWithCount()

Description copied from class: DataLoaderRegistry

Similar to DataLoaderRegistry.dispatchAll(), this calls DataLoader.dispatch() on each of the registered DataLoaders, but returns the number of dispatches.

Overrides:

dispatchAllWithCount in class DataLoaderRegistry

Returns:

total number of entries that were dispatched from registered DataLoaders.

dispatchAllImmediately

public void dispatchAllImmediately()

This will immediately dispatch the DataLoaders in the registry without testing the predicate

dispatchAllWithCountImmediately

public int dispatchAllWithCountImmediately()

This will immediately dispatch the DataLoaders in the registry without testing the predicate

Returns:

total number of entries that were dispatched from registered DataLoaders.

rescheduleNow

public void rescheduleNow()

This will schedule a task to check the predicate and dispatch if true right now. It will not do a pre check of the preodicate like dispatchAll() would

reschedule

private void reschedule(java.lang.String key,
                        DataLoader<?,?> dataLoader)

dispatchOrReschedule

private void dispatchOrReschedule(java.lang.String key,
                                  DataLoader<?,?> dataLoader)

newScheduledRegistry

public static ScheduledDataLoaderRegistry.Builder newScheduledRegistry()

By default this will create use a Executors.newSingleThreadScheduledExecutor() and a schedule duration of 10 milli seconds.

Returns:

A builder of ScheduledDataLoaderRegistrys