org.elasticsearch.indices.recovery

Class RecoveryTarget

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.indices.recovery.RecoveryTarget

public class RecoveryTarget
extends AbstractComponent

The recovery target handles recoveries of peer shards of the shard+node to recover to.

Note, it can be safely assumed that there will only be a single recovery per shard (index+id) and not several of them (since we don't allocate several shard replicas to the same node).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecoveryTarget.Actions
static interface	RecoveryTarget.RecoveryListener

Field Summary

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RecoveryTarget(Settings settings, ThreadPool threadPool, TransportService transportService, IndicesLifecycle indicesLifecycle, RecoverySettings recoverySettings, ClusterService clusterService)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelRecoveriesForShard(ShardId shardId, String reason, com.google.common.base.Predicate<RecoveryStatus> shouldCancel) cancel all ongoing recoveries for the given shard, if their status match a predicate
protected void	retryRecovery(RecoveryStatus recoveryStatus, String reason, TimeValue retryAfter, StartRecoveryRequest currentRequest)
void	startRecovery(IndexShard indexShard, RecoveryState.Type recoveryType, DiscoveryNode sourceNode, RecoveryTarget.RecoveryListener listener)

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

Constructor Detail

RecoveryTarget

@Inject
public RecoveryTarget(Settings settings,
                     ThreadPool threadPool,
                     TransportService transportService,
                     IndicesLifecycle indicesLifecycle,
                     RecoverySettings recoverySettings,
                     ClusterService clusterService)

Method Detail

cancelRecoveriesForShard

public boolean cancelRecoveriesForShard(ShardId shardId,
                               String reason,
                               @Nullable
                               com.google.common.base.Predicate<RecoveryStatus> shouldCancel)

cancel all ongoing recoveries for the given shard, if their status match a predicate

Parameters:

reason - reason for cancellation

shardId - shardId for which to cancel recoveries

shouldCancel - a predicate to check if a recovery should be cancelled or not. Null means cancel without an extra check. note that the recovery state can change after this check, but before it is being cancelled via other already issued outstanding references.

Returns:

true if a recovery was cancelled

startRecovery

public void startRecovery(IndexShard indexShard,
                 RecoveryState.Type recoveryType,
                 DiscoveryNode sourceNode,
                 RecoveryTarget.RecoveryListener listener)

retryRecovery

protected void retryRecovery(RecoveryStatus recoveryStatus,
                 String reason,
                 TimeValue retryAfter,
                 StartRecoveryRequest currentRequest)