org.elasticsearch.indices

Class IndicesLifecycle.Listener

java.lang.Object

org.elasticsearch.indices.IndicesLifecycle.Listener

Enclosing interface:

IndicesLifecycle

public abstract static class IndicesLifecycle.Listener
extends Object

A listener for index and index shard lifecycle events (create/closed).

Constructor Summary

Constructors

Constructor and Description
IndicesLifecycle.Listener()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterIndexClosed(Index index, Settings indexSettings) Called after the index has been closed.
void	afterIndexCreated(IndexService indexService) Called after the index has been created.
void	afterIndexDeleted(Index index, Settings indexSettings) Called after the index has been deleted.
void	afterIndexShardClosed(ShardId shardId, IndexShard indexShard, Settings indexSettings) Called after the index shard has been closed.
void	afterIndexShardCreated(IndexShard indexShard) Called after the index shard has been created.
void	afterIndexShardDeleted(ShardId shardId, Settings indexSettings) Called after the index shard has been deleted from disk.
void	afterIndexShardPostRecovery(IndexShard indexShard) Called right after the shard is moved into POST_RECOVERY mode
void	afterIndexShardStarted(IndexShard indexShard) Called after the index shard has been started.
void	beforeIndexAddedToCluster(Index index, Settings indexSettings) Called on the Master node only before the index is created
void	beforeIndexClosed(IndexService indexService) Called before the index get closed.
void	beforeIndexCreated(Index index, Settings indexSettings) Called before the index gets created.
void	beforeIndexDeleted(IndexService indexService) Called before the index gets deleted.
void	beforeIndexShardClosed(ShardId shardId, IndexShard indexShard, Settings indexSettings) Called before the index shard gets closed.
void	beforeIndexShardCreated(ShardId shardId, Settings indexSettings) Called before the index shard gets created.
void	beforeIndexShardDeleted(ShardId shardId, Settings indexSettings) Called before the index shard gets deleted from disk Note: this method is only executed on the first attempt of deleting the shard.
void	beforeIndexShardPostRecovery(IndexShard indexShard) Called right before the shard is moved into POST_RECOVERY mode.
void	indexShardStateChanged(IndexShard indexShard, IndexShardState previousState, IndexShardState currentState, String reason) Called after a shard's IndexShardState changes.
void	onShardInactive(IndexShard indexShard) Called when a shard is marked as inactive
void	shardRoutingChanged(IndexShard indexShard, ShardRouting oldRouting, ShardRouting newRouting) Called when the shard routing has changed state.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndicesLifecycle.Listener

public IndicesLifecycle.Listener()

Method Detail

shardRoutingChanged

public void shardRoutingChanged(IndexShard indexShard,
                       @Nullable
                       ShardRouting oldRouting,
                       ShardRouting newRouting)

Called when the shard routing has changed state.

Parameters:

indexShard - The index shard

oldRouting - The old routing state (can be null)

newRouting - The new routing state

beforeIndexAddedToCluster

public void beforeIndexAddedToCluster(Index index,
                             Settings indexSettings)

Called on the Master node only before the index is created

beforeIndexCreated

public void beforeIndexCreated(Index index,
                      Settings indexSettings)

Called before the index gets created. Note that this is also called when the index is created on data nodes

afterIndexCreated

public void afterIndexCreated(IndexService indexService)

Called after the index has been created.

beforeIndexShardCreated

public void beforeIndexShardCreated(ShardId shardId,
                           Settings indexSettings)

Called before the index shard gets created.

afterIndexShardCreated

public void afterIndexShardCreated(IndexShard indexShard)

Called after the index shard has been created.

afterIndexShardPostRecovery

public void afterIndexShardPostRecovery(IndexShard indexShard)

Called right after the shard is moved into POST_RECOVERY mode

beforeIndexShardPostRecovery

public void beforeIndexShardPostRecovery(IndexShard indexShard)

Called right before the shard is moved into POST_RECOVERY mode. The shard is ready to be used but not yet marked as POST_RECOVERY.

afterIndexShardStarted

public void afterIndexShardStarted(IndexShard indexShard)

Called after the index shard has been started.

beforeIndexClosed

public void beforeIndexClosed(IndexService indexService)

Called before the index get closed.

Parameters:

indexService - The index service

afterIndexClosed

public void afterIndexClosed(Index index,
                    Settings indexSettings)

Called after the index has been closed.

Parameters:

index - The index

beforeIndexShardClosed

public void beforeIndexShardClosed(ShardId shardId,
                          @Nullable
                          IndexShard indexShard,
                          Settings indexSettings)

Called before the index shard gets closed.

Parameters:

indexShard - The index shard

afterIndexShardClosed

public void afterIndexShardClosed(ShardId shardId,
                         @Nullable
                         IndexShard indexShard,
                         Settings indexSettings)

Called after the index shard has been closed.

Parameters:

shardId - The shard id

beforeIndexShardDeleted

public void beforeIndexShardDeleted(ShardId shardId,
                           Settings indexSettings)

Called before the index shard gets deleted from disk Note: this method is only executed on the first attempt of deleting the shard. Retries are will not invoke this method.

Parameters:

shardId - The shard id

indexSettings - the shards index settings

afterIndexShardDeleted

public void afterIndexShardDeleted(ShardId shardId,
                          Settings indexSettings)

Called after the index shard has been deleted from disk. Note: this method is only called if the deletion of the shard did finish without an exception

Parameters:

shardId - The shard id

indexSettings - the shards index settings

indexShardStateChanged

public void indexShardStateChanged(IndexShard indexShard,
                          @Nullable
                          IndexShardState previousState,
                          IndexShardState currentState,
                          @Nullable
                          String reason)

Called after a shard's IndexShardState changes. The order of concurrent events is preserved. The execution must be lightweight.

Parameters:

indexShard - the shard the new state was applied to

previousState - the previous index shard state if there was one, null otherwise

currentState - the new shard state

reason - the reason for the state change if there is one, null otherwise

afterIndexDeleted

public void afterIndexDeleted(Index index,
                     Settings indexSettings)

Called after the index has been deleted. This listener method is invoked after afterIndexClosed(org.elasticsearch.index.Index, org.elasticsearch.common.settings.Settings) when an index is deleted

Parameters:

index - The index

beforeIndexDeleted

public void beforeIndexDeleted(IndexService indexService)

Called before the index gets deleted. This listener method is invoked after beforeIndexClosed(org.elasticsearch.index.IndexService) when an index is deleted

Parameters:

indexService - The index service

onShardInactive

public void onShardInactive(IndexShard indexShard)

Called when a shard is marked as inactive

Parameters:

indexShard - The shard that was marked inactive