- All Implemented Interfaces:
Closeable,AutoCloseable,ClusterStateListener,LifecycleComponent,Releasable,IndexEventListener
org.elasticsearch.snapshots for details.
See SnapshotsService for the master node snapshotting steps.-
Field Summary
Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
lifecycle -
Constructor Summary
ConstructorsConstructorDescriptionSnapshotShardsService(Settings settings, ClusterService clusterService, RepositoriesService repositoriesService, TransportService transportService, IndicesService indicesService) -
Method Summary
Modifier and TypeMethodDescriptionvoidbeforeIndexShardClosed(ShardId shardId, IndexShard indexShard, Settings indexSettings) Called before the index shard gets closed.voidCalled when cluster state changes.currentSnapshotShards(Snapshot snapshot) Returns status of shards that are snapshotted on the node and belong to the given snapshotprotected voiddoClose()Close this component.protected voiddoStart()Start this component.protected voiddoStop()Stop this component.static StringgetShardStateId(IndexShard indexShard, org.apache.lucene.index.IndexCommit snapshotIndexCommit) Generates an identifier from the current state of a shard that can be used to detect whether a shard's contents have changed between two snapshots.Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, start, stopMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.index.shard.IndexEventListener
afterFilesRestoredFromRepository, afterIndexCreated, afterIndexRemoved, afterIndexShardClosed, afterIndexShardClosing, afterIndexShardCreated, afterIndexShardDeleted, afterIndexShardRecovery, afterIndexShardStarted, beforeIndexAddedToCluster, beforeIndexCreated, beforeIndexRemoved, beforeIndexShardCreated, beforeIndexShardDeleted, beforeIndexShardMutableOperation, beforeIndexShardRecovery, indexShardStateChanged, onStoreClosed, onStoreCreated, shardRoutingChanged
-
Constructor Details
-
SnapshotShardsService
public SnapshotShardsService(Settings settings, ClusterService clusterService, RepositoriesService repositoriesService, TransportService transportService, IndicesService indicesService)
-
-
Method Details
-
doStart
protected void doStart()Description copied from class:AbstractLifecycleComponentStart this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.
This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.- Specified by:
doStartin classAbstractLifecycleComponent
-
doStop
protected void doStop()Description copied from class:AbstractLifecycleComponentStop this component. Typically that means doing the reverse of whateverAbstractLifecycleComponent.doStart()does.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after callingAbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.- Specified by:
doStopin classAbstractLifecycleComponent
-
doClose
protected void doClose()Description copied from class:AbstractLifecycleComponentClose this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.- Specified by:
doClosein classAbstractLifecycleComponent
-
clusterChanged
Description copied from interface:ClusterStateListenerCalled 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:
clusterChangedin interfaceClusterStateListener
-
beforeIndexShardClosed
public void beforeIndexShardClosed(ShardId shardId, @Nullable IndexShard indexShard, Settings indexSettings) Description copied from interface:IndexEventListenerCalled before the index shard gets closed.- Specified by:
beforeIndexShardClosedin interfaceIndexEventListener- Parameters:
indexShard- The index shard
-
currentSnapshotShards
Returns status of shards that are snapshotted on the node and belong to the given snapshotThis method is executed on data node
- Parameters:
snapshot- snapshot- Returns:
- map of shard id to snapshot status
-
getShardStateId
@Nullable public static String getShardStateId(IndexShard indexShard, org.apache.lucene.index.IndexCommit snapshotIndexCommit) throws IOException Generates an identifier from the current state of a shard that can be used to detect whether a shard's contents have changed between two snapshots. A shard is assumed to have unchanged contents if its global- and local checkpoint are equal, its maximum sequence number has not changed and its history- and force-merge-uuid have not changed. The method returnsnullif global and local checkpoint are different for a shard since no safe unique shard state id can be used in this case because of the possibility of a primary failover leading to different shard content for the same sequence number on a subsequent snapshot.- Parameters:
indexShard- ShardsnapshotIndexCommit- IndexCommit for shard- Returns:
- shard state id or
nullif none can be used - Throws:
IOException
-