Package org.elasticsearch.snapshots

Class RestoreService

java.lang.Object

org.elasticsearch.snapshots.RestoreService

All Implemented Interfaces:

ClusterStateApplier

public class RestoreService
extends java.lang.Object
implements ClusterStateApplier

Service responsible for restoring snapshots

Restore operation is performed in several stages.

First restoreSnapshot(RestoreSnapshotRequest, 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, SnapshotRecoverySource) method.

Individual shards are getting restored as part of normal recovery process in IndexShard.restoreFromRepository(org.elasticsearch.repositories.Repository, org.elasticsearch.action.ActionListener<java.lang.Boolean>) )} method, which detects that shard should be restored from snapshot rather than recovered from gateway by looking at the ShardRouting.recoverySource() property.

At the end of the successful restore process RestoreService calls cleanupRestoreState(ClusterChangedEvent), which removes RestoreInProgress 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	Description
static class	RestoreService.RestoreCompletionResponse
static class	RestoreService.RestoreInProgressUpdater

Constructor Summary

Constructors

Constructor	Description
RestoreService(ClusterService clusterService, RepositoriesService repositoriesService, AllocationService allocationService, MetaDataCreateIndexService createIndexService, MetaDataIndexUpgradeService metaDataIndexUpgradeService, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
void	applyClusterState(ClusterChangedEvent event)	Called when a new cluster state (ClusterChangedEvent.state() needs to be applied.
static boolean	completed(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)
static int	failedShards(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)
static boolean	isRepositoryInUse(ClusterState clusterState, java.lang.String repository)	Checks if a repository is currently in use by one of the snapshots
static RestoreInProgress.Entry	restoreInProgress(ClusterState state, java.lang.String restoreUUID)
void	restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreService.RestoreCompletionResponse> listener)	Restores snapshot specified in the restore request.
static java.util.Set<Index>	restoringIndices(ClusterState currentState, java.util.Set<Index> indicesToCheck)	Returns the indices that are currently being restored and that are contained in the indices-to-check set.
static RestoreInProgress	updateRestoreStateWithDeletedIndices(RestoreInProgress oldRestore, java.util.Set<Index> deletedIndices)

Methods inherited from class java.lang.Object

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

Constructor Details

RestoreService

public RestoreService(ClusterService clusterService, RepositoriesService repositoriesService, AllocationService allocationService, MetaDataCreateIndexService createIndexService, MetaDataIndexUpgradeService metaDataIndexUpgradeService, ClusterSettings clusterSettings)

Method Details

restoreSnapshot

public void restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreService.RestoreCompletionResponse> listener)

Restores snapshot specified in the restore request.

Parameters:

request - restore request

listener - restore listener

updateRestoreStateWithDeletedIndices

public static RestoreInProgress updateRestoreStateWithDeletedIndices(RestoreInProgress oldRestore, java.util.Set<Index> deletedIndices)

restoreInProgress

public static RestoreInProgress.Entry restoreInProgress(ClusterState state, java.lang.String restoreUUID)

completed

public static boolean completed(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)

failedShards

public static int failedShards(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)

restoringIndices

public static java.util.Set<Index> restoringIndices(ClusterState currentState, java.util.Set<Index> indicesToCheck)

Returns the indices that are currently being restored and that are contained in the indices-to-check set.

applyClusterState

public void applyClusterState(ClusterChangedEvent event)

Description copied from interface: ClusterStateApplier

Called when a new cluster state (ClusterChangedEvent.state() needs to be applied. The cluster state to be applied is already committed when this method is called, so an applier must therefore be prepared to deal with any state it receives without throwing an exception. Throwing an exception from an applier is very bad because it will stop the application of this state before it has reached all the other appliers, and will likely result in another attempt to apply the same (or very similar) cluster state which might continue until this node is removed from the cluster.

Specified by:

applyClusterState in interface ClusterStateApplier

isRepositoryInUse

public static boolean isRepositoryInUse(ClusterState clusterState, java.lang.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