Package org.apache.accumulo.core.spi.scan

Interface ScanDispatcher

All Known Implementing Classes:

SimpleScanDispatcher

public interface ScanDispatcher

A per table scan dispatcher that decides which executor should be used to process a scan. For information about configuring, find the documentation for the table.scan.dispatcher and table.scan.dispatcher.opts. properties.

Since:

2.0.0

See Also:

• org.apache.accumulo.core.spi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ScanDispatcher.DispatchParameters	The method parameters for dispatch(DispatchParameters).
static interface	ScanDispatcher.DispatchParmaters	Deprecated. since 2.1.0 replaced by ScanDispatcher.DispatchParameters and dispatch(DispatchParameters)
static interface	ScanDispatcher.InitParameters	The method parameters for init(InitParameters).

Method Summary

Modifier and Type	Method	Description
default ScanDispatch	dispatch(ScanDispatcher.DispatchParameters params)	Accumulo calls this method for each scan batch to determine what executor to use and how to utilize cache for the scan.
default String	dispatch(ScanDispatcher.DispatchParmaters params)	Deprecated. since 2.1.0 please implement dispatch(DispatchParameters) instead of this.
default void	init(ScanDispatcher.InitParameters params)	This method is called once after a ScanDispatcher is instantiated.

Method Details

init

default void init(ScanDispatcher.InitParameters params)

This method is called once after a ScanDispatcher is instantiated.

dispatch

@Deprecated(since="2.1.0")
default String dispatch(ScanDispatcher.DispatchParmaters params)

Deprecated.

since 2.1.0 please implement dispatch(DispatchParameters) instead of this. Accumulo will only call dispatch(DispatchParameters) directly, it will never call this. However the default implementation of dispatch(DispatchParameters) calls this method.

Returns:

Should return one of the executors named params.getScanExecutors().keySet()

dispatch

default ScanDispatch dispatch(ScanDispatcher.DispatchParameters params)

Accumulo calls this method for each scan batch to determine what executor to use and how to utilize cache for the scan.

Since:

2.1.0