Package org.elasticsearch.readiness

Class ReadinessService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.readiness.ReadinessService

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateListener, LifecycleComponent, org.elasticsearch.core.Releasable

public class ReadinessService
extends AbstractLifecycleComponent
implements ClusterStateListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReadinessService.BoundAddressListener	A listener to be notified when the readiness service establishes the port it's listening on.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Integer>	PORT

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
ReadinessService(ClusterService clusterService, Environment environment)

Method Summary

Modifier and Type	Method	Description
void	addBoundAddressListener(ReadinessService.BoundAddressListener listener)	Add a listener for bound readiness service address.
BoundTransportAddress	boundAddress()	Returns the current bound address for the readiness service.
void	clusterChanged(ClusterChangedEvent event)	Called when cluster state changes.
protected void	doClose()
protected void	doStart()
protected void	doStop()
static boolean	enabled(Environment environment)	Checks to see if the readiness service is enabled in the current environment

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Details

PORT

public static final Setting<Integer> PORT

Constructor Details

ReadinessService

public ReadinessService(ClusterService clusterService,
 Environment environment)

Method Details

enabled

public static boolean enabled(Environment environment)

Checks to see if the readiness service is enabled in the current environment

Parameters:

environment -

Returns:

boundAddress

public BoundTransportAddress boundAddress()

Returns the current bound address for the readiness service. If Elasticsearch was never ready, this method will return null.

Returns:

the bound address for the readiness service

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.

Specified by:

clusterChanged in interface ClusterStateListener

addBoundAddressListener

public void addBoundAddressListener(ReadinessService.BoundAddressListener listener)

Add a listener for bound readiness service address.

Parameters:

listener -