org.elasticsearch.snapshots

Class RestoreService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.snapshots.RestoreService

All Implemented Interfaces:

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_RESTORE_ACTION_NAME

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RestoreService(Settings settings, ClusterService clusterService, RepositoriesService repositoriesService, TransportService transportService, AllocationService allocationService, MetaDataCreateIndexService createIndexService, DynamicSettings dynamicSettings, MetaDataIndexUpgradeService metaDataIndexUpgradeService)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ActionListener<RestoreService.RestoreCompletionResponse> listener) Adds restore completion listener
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
void	restoreSnapshot(RestoreService.RestoreRequest request, ActionListener<RestoreInfo> listener) Restores snapshot specified in the restore request.

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_RESTORE_ACTION_NAME

public static final String UPDATE_RESTORE_ACTION_NAME

See Also:

Constant Field Values

Constructor Detail

RestoreService

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

Method Detail

restoreSnapshot

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

Restores snapshot specified in the restore request.

Parameters:

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.

Parameters:

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.

Parameters:

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.

Parameters:

listener - restore completion listener

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Specified by:

clusterChanged in interface ClusterStateListener

isRepositoryInUse

public static boolean isRepositoryInUse(ClusterState clusterState,
                        String repository)

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

Parameters:

clusterState - cluster state

repository - repository id

Returns:

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