org.elasticsearch.snapshots

クラス RestoreService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.snapshots.RestoreService

すべての実装されたインタフェース:

ClusterStateListener

public class RestoreService
extends AbstractComponent
implements ClusterStateListener

Service responsible for restoring snapshots

Restore operation is performed in several stages.

First restoreSnapshot(RestoreRequest, org.elasticsearch.action.ActionListener) method reads information about snapshot and metadata from repository. In update cluster state task it checks restore preconditions, restores global state if needed, creates RestoreInProgress record with list of shards that needs to be restored and adds this shard to the routing table using RoutingTable.Builder.addAsRestore(IndexMetaData, RestoreSource) method.

Individual shards are getting restored as part of normal recovery process in StoreRecoveryService.recover(IndexShard, boolean, StoreRecoveryService.RecoveryListener) method, which detects that shard should be restored from snapshot rather than recovered from gateway by looking at the ShardRouting.restoreSource() property. If this property is not null recover method uses StoreRecoveryService.restore(org.elasticsearch.index.shard.IndexShard, org.elasticsearch.indices.recovery.RecoveryState) method to start shard restore process.

At the end of the successful restore process IndexShardSnapshotAndRestoreService calls indexShardRestoreCompleted(SnapshotId, ShardId), which updates RestoreInProgress in cluster state or removes it when all shards are completed. In case of restore failure a normal recovery fail-over process kicks in.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	RestoreService.RestoreCompletionResponse
static class	RestoreService.RestoreRequest Restore snapshot request
static class	RestoreService.UpdateIndexShardRestoreStatusRequest Internal class that is used to send notifications about finished shard restore operations to master node

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	UPDATE_RESTORE_ACTION_NAME

クラスから継承されたフィールド org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
RestoreService(Settings settings, ClusterService clusterService, RepositoriesService repositoriesService, TransportService transportService, AllocationService allocationService, MetaDataCreateIndexService createIndexService, DynamicSettings dynamicSettings, MetaDataIndexUpgradeService metaDataIndexUpgradeService)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addListener(ActionListener<RestoreService.RestoreCompletionResponse> listener) Adds restore completion listener This listener is called for each snapshot that finishes restore operation in the cluster.
void	clusterChanged(ClusterChangedEvent event) Called when cluster state changes.
void	failRestore(SnapshotId snapshotId, ShardId shardId) Fails the given snapshot restore operation for the given shard
void	indexShardRestoreCompleted(SnapshotId snapshotId, ShardId shardId) This method is used by StoreRecoveryService to notify RestoreService about shard restore completion.
static boolean	isRepositoryInUse(ClusterState clusterState, String repository) Checks if a repository is currently in use by one of the snapshots
void	removeListener(ActionListener<RestoreService.RestoreCompletionResponse> listener) Removes restore completion listener This listener is called for each snapshot that finishes restore operation in the cluster.
void	restoreSnapshot(RestoreService.RestoreRequest request, ActionListener<RestoreInfo> listener) Restores snapshot specified in the restore request.

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

UPDATE_RESTORE_ACTION_NAME

public static final String UPDATE_RESTORE_ACTION_NAME

関連項目:

定数フィールド値

コンストラクタの詳細

RestoreService

@Inject
public RestoreService(Settings settings,
                              ClusterService clusterService,
                              RepositoriesService repositoriesService,
                              TransportService transportService,
                              AllocationService allocationService,
                              MetaDataCreateIndexService createIndexService,
                              @ClusterDynamicSettings
                              DynamicSettings dynamicSettings,
                              MetaDataIndexUpgradeService metaDataIndexUpgradeService)

メソッドの詳細

restoreSnapshot

public void restoreSnapshot(RestoreService.RestoreRequest request,
                            ActionListener<RestoreInfo> listener)

Restores snapshot specified in the restore request.

パラメータ:

request - restore request

listener - restore listener

indexShardRestoreCompleted

public void indexShardRestoreCompleted(SnapshotId snapshotId,
                                       ShardId shardId)

This method is used by StoreRecoveryService to notify RestoreService about shard restore completion.

パラメータ:

snapshotId - snapshot id

shardId - shard id

failRestore

public void failRestore(SnapshotId snapshotId,
                        ShardId shardId)

Fails the given snapshot restore operation for the given shard

addListener

public void addListener(ActionListener<RestoreService.RestoreCompletionResponse> listener)

Adds restore completion listener

This listener is called for each snapshot that finishes restore operation in the cluster. It's responsibility of the listener to decide if it's called for the appropriate snapshot or not.

パラメータ:

listener - restore completion listener

removeListener

public void removeListener(ActionListener<RestoreService.RestoreCompletionResponse> listener)

Removes restore completion listener

This listener is called for each snapshot that finishes restore operation in the cluster.

パラメータ:

listener - restore completion listener

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

インタフェースからコピーされた説明: ClusterStateListener

Called when cluster state changes.

定義:

clusterChanged インタフェース内 ClusterStateListener

isRepositoryInUse

public static boolean isRepositoryInUse(ClusterState clusterState,
                                        String repository)

Checks if a repository is currently in use by one of the snapshots

パラメータ:

clusterState - cluster state

repository - repository id

戻り値:

true if repository is currently in use by one of the running snapshots