org.gridgain.grid.kernal.processors.dataload

Class GridDataLoaderImpl<K,V>

java.lang.Object

org.gridgain.grid.kernal.processors.dataload.GridDataLoaderImpl<K,V>

All Implemented Interfaces:

AutoCloseable, Comparable<Delayed>, Delayed, GridDataLoader<K,V>

public class GridDataLoaderImpl<K,V>
extends Object
implements GridDataLoader<K,V>, Delayed

Data loader implementation.

Field Summary

Fields inherited from interface org.gridgain.grid.dataload.GridDataLoader

DFLT_MAX_PARALLEL_OPS, DFLT_PER_NODE_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
GridDataLoaderImpl(GridKernalContext ctx, String cacheName, DelayQueue<GridDataLoaderImpl<K,V>> flushQ)

Method Summary

Methods

Modifier and Type	Method and Description
GridFuture<?>	addData(Collection<? extends Map.Entry<K,V>> entries) Adds data for loading on remote node.
GridFuture<?>	addData(K key, V val) Adds data for loading on remote node.
GridFuture<?>	addData(Map.Entry<K,V> entry) Adds data for loading on remote node.
GridFuture<?>	addData(Map<K,V> entries) Adds data for loading on remote node.
long	autoFlushFrequency() Gets automatic flush frequency.
void	autoFlushFrequency(long autoFlushFreq) Sets automatic flush frequency.
String	cacheName() Name of cache to load data to.
void	close() Closes data loader.
void	close(boolean cancel) Loads any remaining data and closes this loader.
int	compareTo(Delayed o)
void	deployClass(Class<?> depCls) Optional deploy class for peer deployment.
void	flush() Loads any remaining data, but doesn't close the loader.
GridFuture<?>	future() Gets future for this loading process.
long	getDelay(TimeUnit unit)
boolean	isolated() Gets flag value indicating that this data loader assumes that there are no other concurrent updates to the cache.
void	isolated(boolean isolated) Sets flag indicating that this data loader should assume that there are no other concurrent updates to the cache.
int	perNodeBufferSize() Gets size of per node key-value pairs buffer.
void	perNodeBufferSize(int bufSize) Sets size of per node key-value pairs buffer.
int	perNodeParallelLoadOperations() Gets maximum number of parallel load operations for a single node.
void	perNodeParallelLoadOperations(int parallelOps) Sets maximum number of parallel load operations for a single node.
GridFuture<?>	removeData(K key) Adds key for removal on remote node.
String	toString()
void	tryFlush() Flushes every internal buffer if buffer was flushed before passed in threshold.
void	updater(GridDataLoadCacheUpdater<K,V> updater) Sets custom cache updater to this data loader.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDataLoaderImpl

public GridDataLoaderImpl(GridKernalContext ctx,
                  @Nullable
                  String cacheName,
                  DelayQueue<GridDataLoaderImpl<K,V>> flushQ)

Parameters:

ctx - Grid kernal context.

cacheName - Cache name.

flushQ - Flush queue.

Method Detail

future

public GridFuture<?> future()

Gets future for this loading process. This future completes whenever method GridDataLoader.close(boolean) completes. By attaching listeners to this future it is possible to get asynchronous notifications for completion of this loading process.

Specified by:

future in interface GridDataLoader<K,V>

Returns:

Future for this loading process.

deployClass

public void deployClass(Class<?> depCls)

Optional deploy class for peer deployment. All classes loaded by a data loader must be class-loadable from the same class-loader. GridGain will make the best effort to detect the most suitable class-loader for data loading. However, in complex cases, where compound or deeply nested class-loaders are used, it is best to specify a deploy class which can be any class loaded by the class-loader for given data.

Specified by:

deployClass in interface GridDataLoader<K,V>

Parameters:

depCls - Any class loaded by the class-loader for given data.

updater

public void updater(GridDataLoadCacheUpdater<K,V> updater)

Sets custom cache updater to this data loader.

Specified by:

updater in interface GridDataLoader<K,V>

Parameters:

updater - Cache updater.

isolated

public boolean isolated()

Gets flag value indicating that this data loader assumes that there are no other concurrent updates to the cache. Default is false.

Specified by:

isolated in interface GridDataLoader<K,V>

Returns:

Flag value.

isolated

public void isolated(boolean isolated)
              throws GridException

Sets flag indicating that this data loader should assume that there are no other concurrent updates to the cache. Should not be used when custom cache updater set using GridDataLoader.updater(GridDataLoadCacheUpdater) method. Default is false.

Specified by:

isolated in interface GridDataLoader<K,V>

Parameters:

isolated - Flag value.

Throws:

GridException - If failed.

cacheName

@Nullable
public String cacheName()

Name of cache to load data to.

Specified by:

cacheName in interface GridDataLoader<K,V>

Returns:

Cache name or null for default cache.

perNodeBufferSize

public int perNodeBufferSize()

Gets size of per node key-value pairs buffer.

Specified by:

perNodeBufferSize in interface GridDataLoader<K,V>

Returns:

Per node buffer size.

perNodeBufferSize

public void perNodeBufferSize(int bufSize)

Sets size of per node key-value pairs buffer.

This method should be called prior to GridDataLoader.addData(Object, Object) call.

If not provided, default value is GridDataLoader.DFLT_PER_NODE_BUFFER_SIZE.

Specified by:

perNodeBufferSize in interface GridDataLoader<K,V>

Parameters:

bufSize - Per node buffer size.

perNodeParallelLoadOperations

public int perNodeParallelLoadOperations()

Gets maximum number of parallel load operations for a single node.

Specified by:

perNodeParallelLoadOperations in interface GridDataLoader<K,V>

Returns:

Maximum number of parallel load operations for a single node.

perNodeParallelLoadOperations

public void perNodeParallelLoadOperations(int parallelOps)

Sets maximum number of parallel load operations for a single node.

This method should be called prior to GridDataLoader.addData(Object, Object) call.

If not provided, default value is GridDataLoader.DFLT_MAX_PARALLEL_OPS.

Specified by:

perNodeParallelLoadOperations in interface GridDataLoader<K,V>

Parameters:

parallelOps - Maximum number of parallel load operations for a single node.

autoFlushFrequency

public long autoFlushFrequency()

Gets automatic flush frequency. Essentially, this is the time after which the loader will make an attempt to submit all data added so far to remote nodes. Note that there is no guarantee that data will be delivered after this concrete attempt (e.g., it can fail when topology is changing), but it won't be lost anyway.

If set to 0, automatic flush is disabled.

Automatic flush is disabled by default (default value is 0).

Specified by:

autoFlushFrequency in interface GridDataLoader<K,V>

Returns:

Flush frequency or 0 if automatic flush is disabled.

See Also:

GridDataLoader.flush()

autoFlushFrequency

public void autoFlushFrequency(long autoFlushFreq)

Sets automatic flush frequency. Essentially, this is the time after which the loader will make an attempt to submit all data added so far to remote nodes. Note that there is no guarantee that data will be delivered after this concrete attempt (e.g., it can fail when topology is changing), but it won't be lost anyway.

If set to 0, automatic flush is disabled.

Automatic flush is disabled by default (default value is 0).

Specified by:

autoFlushFrequency in interface GridDataLoader<K,V>

Parameters:

autoFlushFreq - Flush frequency or 0 to disable automatic flush.

See Also:

GridDataLoader.flush()

addData

public GridFuture<?> addData(Map<K,V> entries)
                      throws IllegalStateException

Adds data for loading on remote node. This method can be called from multiple threads in parallel to speed up loading if needed.

Note that loader will load data concurrently by multiple internal threads, so the data may get to remote nodes in different order from which it was added to the loader.

Specified by:

addData in interface GridDataLoader<K,V>

Parameters:

entries - Map to be loaded.

Returns:

Future for this load operation.

Throws:

IllegalStateException - If grid has been concurrently stopped or GridDataLoader.close(boolean) has already been called on loader.

addData

public GridFuture<?> addData(Collection<? extends Map.Entry<K,V>> entries)

Adds data for loading on remote node. This method can be called from multiple threads in parallel to speed up loading if needed.

Note that loader will load data concurrently by multiple internal threads, so the data may get to remote nodes in different order from which it was added to the loader.

Specified by:

addData in interface GridDataLoader<K,V>

Parameters:

entries - Collection of entries to be loaded.

Returns:

Future for this load operation.

addData

public GridFuture<?> addData(Map.Entry<K,V> entry)
                      throws GridException,
                             IllegalStateException

Adds data for loading on remote node. This method can be called from multiple threads in parallel to speed up loading if needed.

Note that loader will load data concurrently by multiple internal threads, so the data may get to remote nodes in different order from which it was added to the loader.

Specified by:

addData in interface GridDataLoader<K,V>

Parameters:

entry - Entry.

Returns:

Future fo this operation.

Throws:

GridException - If failed to map key to node.

GridInterruptedException - If thread has been interrupted.

IllegalStateException - If grid has been concurrently stopped or GridDataLoader.close(boolean) has already been called on loader.

addData

public GridFuture<?> addData(K key,
                    V val)
                      throws GridException,
                             IllegalStateException

Adds data for loading on remote node. This method can be called from multiple threads in parallel to speed up loading if needed.

Note that loader will load data concurrently by multiple internal threads, so the data may get to remote nodes in different order from which it was added to the loader.

Specified by:

addData in interface GridDataLoader<K,V>

Parameters:

key - Key.

val - Value or null if respective entry must be removed from cache.

Returns:

Future fo this operation.

Throws:

GridException - If failed to map key to node.

GridInterruptedException - If thread has been interrupted.

IllegalStateException - If grid has been concurrently stopped or GridDataLoader.close(boolean) has already been called on loader.

removeData

public GridFuture<?> removeData(K key)
                         throws GridException,
                                IllegalStateException

Adds key for removal on remote node. Equivalent to addData(key, null).

Specified by:

removeData in interface GridDataLoader<K,V>

Parameters:

key - Key.

Returns:

Future fo this operation.

Throws:

GridException - If failed to map key to node.

GridInterruptedException - If thread has been interrupted.

IllegalStateException - If grid has been concurrently stopped or GridDataLoader.close(boolean) has already been called on loader.

flush

public void flush()
           throws GridException

Loads any remaining data, but doesn't close the loader. Data can be still added after flush is finished. This method blocks and doesn't allow to add any data until all data is loaded.

If another thread is already performing flush, this method will block, wait for another thread to complete flush and exit. If you don't want to wait in this case, use GridDataLoader.tryFlush() method.

Specified by:

flush in interface GridDataLoader<K,V>

Throws:

GridException - If failed to map key to node.

GridInterruptedException - If thread has been interrupted.

See Also:

GridDataLoader.tryFlush()

tryFlush

public void tryFlush()
              throws GridInterruptedException

Flushes every internal buffer if buffer was flushed before passed in threshold.

Does not wait for result and does not fail on errors assuming that this method should be called periodically.

Specified by:

tryFlush in interface GridDataLoader<K,V>

Throws:

GridInterruptedException - If thread has been interrupted.

See Also:

GridDataLoader.flush()

close

public void close(boolean cancel)
           throws GridException

Description copied from interface: GridDataLoader

Loads any remaining data and closes this loader.

Specified by:

close in interface GridDataLoader<K,V>

Parameters:

cancel - True to close with cancellation.

Throws:

GridException - If failed.

close

public void close()
           throws GridException

Closes data loader. This method is identical to calling close(false) method.

The method is invoked automatically on objects managed by the try-with-resources statement.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface GridDataLoader<K,V>

Throws:

GridException - If failed to close data loader.

GridInterruptedException - If thread has been interrupted.

toString

public String toString()

Overrides:

toString in class Object

getDelay

public long getDelay(TimeUnit unit)

Specified by:

getDelay in interface Delayed

compareTo

public int compareTo(Delayed o)

Specified by:

compareTo in interface Comparable<Delayed>