com.arakelian.elastic.refresh

Class RefreshLimiter

java.lang.Object

com.arakelian.elastic.refresh.RefreshLimiter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class RefreshLimiter
extends java.lang.Object
implements java.io.Closeable

Indexes or deletes a group of documents from one or more Elastic indexes using the Elastic Bulk Index API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RefreshLimiter.Index Maintains information about the state of each Elastic index that we are tracking.

Constructor Summary

Constructors

Constructor and Description
RefreshLimiter(RefreshLimiterConfig config, ElasticClient elasticClient)

Method Summary

Modifier and Type	Method and Description
void	close() Called during shutdown to terminate the scheduled executor thread.
void	enqueueRefresh(java.lang.String name) Refreshes the given index asynchronously.
ElasticClient	getElasticClient() Returns a reference to our ElasticClient.
RefreshStats	getStats(java.lang.String name)
java.lang.String	toString()
boolean	tryRefresh(java.lang.String name)
boolean	tryRefresh(java.lang.String name, long timeout, java.util.concurrent.TimeUnit unit)
boolean	waitForRefresh(java.lang.String name, long timeout, java.util.concurrent.TimeUnit unit) Returns true if Elastic refresh is required and occurred within the given time frame; also returns true if refresh is not required.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshLimiter

public RefreshLimiter(RefreshLimiterConfig config,
                      ElasticClient elasticClient)

Method Detail

close

public void close()

Called during shutdown to terminate the scheduled executor thread.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

enqueueRefresh

public void enqueueRefresh(java.lang.String name)
                    throws java.util.concurrent.RejectedExecutionException

Refreshes the given index asynchronously.

Parameters:

name - index name

Throws:

java.util.concurrent.RejectedExecutionException - if exceptions occurs while refreshing index

getElasticClient

public final ElasticClient getElasticClient()

Returns a reference to our ElasticClient.

Returns:

reference to our ElasticClient.

getStats

public RefreshStats getStats(java.lang.String name)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

tryRefresh

public boolean tryRefresh(java.lang.String name)

tryRefresh

public boolean tryRefresh(java.lang.String name,
                          long timeout,
                          java.util.concurrent.TimeUnit unit)
                   throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

waitForRefresh

public boolean waitForRefresh(java.lang.String name,
                              long timeout,
                              java.util.concurrent.TimeUnit unit)

Returns true if Elastic refresh is required and occurred within the given time frame; also returns true if refresh is not required.

Parameters:

name - index name

timeout - Length of time in milliseconds to wait for a refresh to occur

unit - timeout units

Returns:

Returns true if there are no dirty indices, false otherwise after timeout period