Package org.dataloader

Class BatchLoaderEnvironment

java.lang.Object

org.dataloader.BatchLoaderEnvironment

@PublicApi
@NullMarked
public class BatchLoaderEnvironment
extends Object

This object is passed to a batch loader as calling context. It could contain security credentials of the calling users for example or database parameters that allow the data layer call to succeed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchLoaderEnvironment.Builder

Method Summary

Modifier and Type	Method	Description
<T> @Nullable T	getContext()	Returns the overall context object provided by BatchLoaderContextProvider
Map<Object,Object>	getKeyContexts()	Each call to DataLoader.load(Object, Object) or DataLoader.loadMany(java.util.List, java.util.List) can be given a context object when it is invoked.
List<Object>	getKeyContextsList()	Each call to DataLoader.load(Object, Object) or DataLoader.loadMany(java.util.List, java.util.List) can be given a context object when it is invoked.
static BatchLoaderEnvironment.Builder	newBatchLoaderEnvironment()

Methods inherited from class java.lang.Object

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

Method Details

getContext

public <T> @Nullable T getContext()

Returns the overall context object provided by BatchLoaderContextProvider

Type Parameters:

T - the type you would like the object to be

Returns:

a context object or null if there isn't one

getKeyContexts

public Map<Object,Object> getKeyContexts()

Each call to DataLoader.load(Object, Object) or DataLoader.loadMany(java.util.List, java.util.List) can be given a context object when it is invoked. A map of them is present by this method.

Returns:

a map of key context objects

getKeyContextsList

public List<Object> getKeyContextsList()

Each call to DataLoader.load(Object, Object) or DataLoader.loadMany(java.util.List, java.util.List) can be given a context object when it is invoked. A list of them is present by this method.

Returns:

a list of key context objects in the order they were encountered

newBatchLoaderEnvironment

public static BatchLoaderEnvironment.Builder newBatchLoaderEnvironment()