Package org.dataloader.instrumentation

Class ChainedDataLoaderInstrumentation

java.lang.Object

org.dataloader.instrumentation.ChainedDataLoaderInstrumentation

All Implemented Interfaces:

DataLoaderInstrumentation

@PublicApi
public class ChainedDataLoaderInstrumentation
extends java.lang.Object
implements DataLoaderInstrumentation

This DataLoaderInstrumentation can chain together multiple instrumentations and have them all called in the order of the provided list.

Constructor Summary

Constructors

Constructor	Description
ChainedDataLoaderInstrumentation()
ChainedDataLoaderInstrumentation(java.util.List<DataLoaderInstrumentation> instrumentations)

Method Summary

Modifier and Type	Method	Description
ChainedDataLoaderInstrumentation	add(DataLoaderInstrumentation instrumentation)	Adds a new DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation
ChainedDataLoaderInstrumentation	addAll(java.util.Collection<DataLoaderInstrumentation> instrumentations)	Adds a collection of DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation
DataLoaderInstrumentationContext<java.util.List<?>>	beginBatchLoader(DataLoader<?,?> dataLoader, java.util.List<?> keys, BatchLoaderEnvironment environment)	This call back is done just before the `batch loader` of a DataLoader is invoked.
DataLoaderInstrumentationContext<DispatchResult<?>>	beginDispatch(DataLoader<?,?> dataLoader)	This call back is done just before the DataLoader.dispatch() is invoked, and it completes when the dispatch call promise is done.
DataLoaderInstrumentationContext<java.lang.Object>	beginLoad(DataLoader<?,?> dataLoader, java.lang.Object key, java.lang.Object loadContext)	This call back is done just before the DataLoader.load(Object) methods are invoked, and it completes when the load promise is completed.
java.util.List<DataLoaderInstrumentation>	getInstrumentations()
ChainedDataLoaderInstrumentation	prepend(DataLoaderInstrumentation instrumentation)	Prepends a new DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainedDataLoaderInstrumentation

public ChainedDataLoaderInstrumentation()

ChainedDataLoaderInstrumentation

public ChainedDataLoaderInstrumentation(java.util.List<DataLoaderInstrumentation> instrumentations)

Method Detail

getInstrumentations

public java.util.List<DataLoaderInstrumentation> getInstrumentations()

add

public ChainedDataLoaderInstrumentation add(DataLoaderInstrumentation instrumentation)

Adds a new DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation

Parameters:

instrumentation - the one to add

Returns:

a new ChainedDataLoaderInstrumentation object

prepend

public ChainedDataLoaderInstrumentation prepend(DataLoaderInstrumentation instrumentation)

Prepends a new DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation

Parameters:

instrumentation - the one to add

Returns:

a new ChainedDataLoaderInstrumentation object

addAll

public ChainedDataLoaderInstrumentation addAll(java.util.Collection<DataLoaderInstrumentation> instrumentations)

Adds a collection of DataLoaderInstrumentation to the list and creates a new ChainedDataLoaderInstrumentation

Parameters:

instrumentations - the new ones to add

Returns:

a new ChainedDataLoaderInstrumentation object

beginLoad

public DataLoaderInstrumentationContext<java.lang.Object> beginLoad(DataLoader<?,?> dataLoader,
                                                                    java.lang.Object key,
                                                                    java.lang.Object loadContext)

Description copied from interface: DataLoaderInstrumentation

This call back is done just before the DataLoader.load(Object) methods are invoked, and it completes when the load promise is completed. If the value is a cached CompletableFuture then it might return almost immediately, otherwise it will return when the batch load function is invoked and values get returned

Specified by:

beginLoad in interface DataLoaderInstrumentation

Parameters:

dataLoader - the DataLoader in question

key - the key used during the DataLoader.load(Object) call

loadContext - the load context used during the DataLoader.load(Object, Object) call

Returns:

a DataLoaderInstrumentationContext or null to be more performant

beginDispatch

public DataLoaderInstrumentationContext<DispatchResult<?>> beginDispatch(DataLoader<?,?> dataLoader)

Description copied from interface: DataLoaderInstrumentation

This call back is done just before the DataLoader.dispatch() is invoked, and it completes when the dispatch call promise is done.

Specified by:

beginDispatch in interface DataLoaderInstrumentation

Parameters:

dataLoader - the DataLoader in question

Returns:

a DataLoaderInstrumentationContext or null to be more performant

beginBatchLoader

public DataLoaderInstrumentationContext<java.util.List<?>> beginBatchLoader(DataLoader<?,?> dataLoader,
                                                                            java.util.List<?> keys,
                                                                            BatchLoaderEnvironment environment)

Description copied from interface: DataLoaderInstrumentation

This call back is done just before the `batch loader` of a DataLoader is invoked. Remember a batch loader could be called multiple times during a dispatch event (because of max batch sizes)

Specified by:

beginBatchLoader in interface DataLoaderInstrumentation

Parameters:

dataLoader - the DataLoader in question

keys - the set of keys being fetched

environment - the BatchLoaderEnvironment

Returns:

a DataLoaderInstrumentationContext or null to be more performant