com.blacklocus.jres

Class JresBulkRequestor

java.lang.Object

com.blacklocus.jres.JresBulkRequestor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable

public class JresBulkRequestor
extends java.lang.Object
implements java.lang.Runnable, java.io.Closeable

Helper that aggregates JresBulkable operations and submits them in batch according to constructor parameters.

Be sure to start() this requestor. This requestor can be properly shutdown if such behavior is desired through close(). Allow ample time for the buffers to flush and submit to ElasticSearch (see CLOSING_LENIENCY_SECONDS).

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSING_LENIENCY_SECONDS Amount of time close() should wait for buffers to flush and submit before excepting.
static int	POLLING_LENIENCY_SECONDS Polling lenience, how long in seconds each poll to the transfer queue is willing to wait.

Constructor Summary

Constructors

Constructor and Description
JresBulkRequestor(int batchSize, int sleepIntervalMs, int numThreads, com.blacklocus.jres.Jres jres) Create a JresBulkRequestor which does not default to any particular index nor type.
JresBulkRequestor(int batchSize, int sleepIntervalMs, int numThreads, java.lang.String targetIndex, com.blacklocus.jres.Jres jres) Create a JresBulkRequestor defaulting to a particular index.
JresBulkRequestor(int batchSize, int sleepIntervalMs, int numThreads, java.lang.String targetIndex, java.lang.String targetType, com.blacklocus.jres.Jres jres) Create a JresBulkRequestor defaulting to a particular index.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Waits for the internal document indexing queue to empty.
java.util.concurrent.Future<?>	offer(com.blacklocus.jres.request.JresBulkable bulkable, long timeout, java.util.concurrent.TimeUnit unit)
java.util.concurrent.Future<?>	put(com.blacklocus.jres.request.JresBulkable bulkable)
void	run()
JresBulkRequestor	start()

Methods inherited from class java.lang.Object

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

Field Detail

POLLING_LENIENCY_SECONDS

public static final int POLLING_LENIENCY_SECONDS

Polling lenience, how long in seconds each poll to the transfer queue is willing to wait.

See Also:

Constant Field Values

CLOSING_LENIENCY_SECONDS

public static final int CLOSING_LENIENCY_SECONDS

Amount of time close() should wait for buffers to flush and submit before excepting.

See Also:

Constant Field Values

Constructor Detail

JresBulkRequestor

public JresBulkRequestor(int batchSize,
                 int sleepIntervalMs,
                 int numThreads,
                 com.blacklocus.jres.Jres jres)

Create a JresBulkRequestor which does not default to any particular index nor type. This means each received JresBulkable must specify their index and type.

Be sure to start() this requestor

JresBulkRequestor

public JresBulkRequestor(int batchSize,
                 int sleepIntervalMs,
                 int numThreads,
                 @Nullable
                 java.lang.String targetIndex,
                 com.blacklocus.jres.Jres jres)

Create a JresBulkRequestor defaulting to a particular index. This means all received JresBulkable must specify their type, but if their index is not specified will default to the one given here.

Be sure to start() this requestor

JresBulkRequestor

public JresBulkRequestor(int batchSize,
                 int sleepIntervalMs,
                 int numThreads,
                 @Nullable
                 java.lang.String targetIndex,
                 @Nullable
                 java.lang.String targetType,
                 com.blacklocus.jres.Jres jres)

Create a JresBulkRequestor defaulting to a particular index. This means JresBulkable that specify their index or type will be placed there. But for unspecified will default to the parameters given here.

Be sure to start() this requestor

Method Detail

start

public JresBulkRequestor start()

Returns:

starts the configured number of threads.

put

public java.util.concurrent.Future<?> put(com.blacklocus.jres.request.JresBulkable bulkable)

Returns:

a future which can be used to block the calling thread until the receiving end signals that the received document has been successfully submitted in a bulk request to ElasticSearch. If ElasticSearch indicates an error for this particular ProductPage in the request, the returned Future.get() will except.

offer

public java.util.concurrent.Future<?> offer(com.blacklocus.jres.request.JresBulkable bulkable,
                                   long timeout,
                                   java.util.concurrent.TimeUnit unit)

Returns:

a future which can be used to block the calling thread until the receiving end signals that the received document has been successfully submitted in a bulk request to ElasticSearch. If ElasticSearch indicates an error for this particular ProductPage in the request, the returned Future.get() will except. null if the offer failed to commit in the timeout allotted.

run

public void run()

Specified by:

run in interface java.lang.Runnable

close

public void close()
           throws java.io.IOException

Waits for the internal document indexing queue to empty. Then interrupts IndexerWorkers which should be coded to handle interrupts. The IndexerWorkers should then submit their currently pending batch of documents in their final ElasticSearch _bulk request and exit normally.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - particularly, if interrupted