org.elasticsearch.indices.recovery

Class RemoteRecoveryTargetHandler

java.lang.Object

org.elasticsearch.indices.recovery.RemoteRecoveryTargetHandler

All Implemented Interfaces:

RecoveryTargetHandler

public class RemoteRecoveryTargetHandler
extends java.lang.Object
implements RecoveryTargetHandler

Constructor Summary

Constructors

Constructor and Description
RemoteRecoveryTargetHandler(long recoveryId, ShardId shardId, TransportService transportService, DiscoveryNode targetNode, RecoverySettings recoverySettings, java.util.function.Consumer<java.lang.Long> onSourceThrottle)

Method Summary

Modifier and Type	Method and Description
void	cleanFiles(int totalTranslogOps, Store.MetadataSnapshot sourceMetaData) After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source store
void	ensureClusterStateVersion(long clusterStateVersion) Blockingly waits for cluster state with at least clusterStateVersion to be available
void	finalizeRecovery(long globalCheckpoint) The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, and updates the global checkpoint.
void	handoffPrimaryContext(GlobalCheckpointTracker.PrimaryContext primaryContext) Handoff the primary context between the relocation source and the relocation target.
long	indexTranslogOperations(java.util.List<Translog.Operation> operations, int totalTranslogOps) Index a set of translog operations on the target
void	prepareForTranslogOperations(int totalTranslogOps) Prepares the target to receive translog operations, after all file have been copied
void	receiveFileInfo(java.util.List<java.lang.String> phase1FileNames, java.util.List<java.lang.Long> phase1FileSizes, java.util.List<java.lang.String> phase1ExistingFileNames, java.util.List<java.lang.Long> phase1ExistingFileSizes, int totalTranslogOps) Notifies the target of the files it is going to receive
void	writeFileChunk(StoreFileMetaData fileMetaData, long position, BytesReference content, boolean lastChunk, int totalTranslogOps) writes a partial file chunk to the target store

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteRecoveryTargetHandler

public RemoteRecoveryTargetHandler(long recoveryId,
                                   ShardId shardId,
                                   TransportService transportService,
                                   DiscoveryNode targetNode,
                                   RecoverySettings recoverySettings,
                                   java.util.function.Consumer<java.lang.Long> onSourceThrottle)

Method Detail

prepareForTranslogOperations

public void prepareForTranslogOperations(int totalTranslogOps)
                                  throws java.io.IOException

Description copied from interface: RecoveryTargetHandler

Prepares the target to receive translog operations, after all file have been copied

Specified by:

prepareForTranslogOperations in interface RecoveryTargetHandler

Parameters:

totalTranslogOps - total translog operations expected to be sent

Throws:

java.io.IOException

finalizeRecovery

public void finalizeRecovery(long globalCheckpoint)

Description copied from interface: RecoveryTargetHandler

The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, and updates the global checkpoint.

Specified by:

finalizeRecovery in interface RecoveryTargetHandler

Parameters:

globalCheckpoint - the global checkpoint on the recovery source

ensureClusterStateVersion

public void ensureClusterStateVersion(long clusterStateVersion)

Description copied from interface: RecoveryTargetHandler

Blockingly waits for cluster state with at least clusterStateVersion to be available

Specified by:

ensureClusterStateVersion in interface RecoveryTargetHandler

handoffPrimaryContext

public void handoffPrimaryContext(GlobalCheckpointTracker.PrimaryContext primaryContext)

Description copied from interface: RecoveryTargetHandler

Handoff the primary context between the relocation source and the relocation target.

Specified by:

handoffPrimaryContext in interface RecoveryTargetHandler

Parameters:

primaryContext - the primary context from the relocation source

indexTranslogOperations

public long indexTranslogOperations(java.util.List<Translog.Operation> operations,
                                    int totalTranslogOps)

Description copied from interface: RecoveryTargetHandler

Index a set of translog operations on the target

Specified by:

indexTranslogOperations in interface RecoveryTargetHandler

Parameters:

operations - operations to index

totalTranslogOps - current number of total operations expected to be indexed

Returns:

the local checkpoint on the target shard

receiveFileInfo

public void receiveFileInfo(java.util.List<java.lang.String> phase1FileNames,
                            java.util.List<java.lang.Long> phase1FileSizes,
                            java.util.List<java.lang.String> phase1ExistingFileNames,
                            java.util.List<java.lang.Long> phase1ExistingFileSizes,
                            int totalTranslogOps)

Description copied from interface: RecoveryTargetHandler

Notifies the target of the files it is going to receive

Specified by:

receiveFileInfo in interface RecoveryTargetHandler

cleanFiles

public void cleanFiles(int totalTranslogOps,
                       Store.MetadataSnapshot sourceMetaData)
                throws java.io.IOException

Description copied from interface: RecoveryTargetHandler

After all source files has been sent over, this command is sent to the target so it can clean any local files that are not part of the source store

Specified by:

cleanFiles in interface RecoveryTargetHandler

Parameters:

totalTranslogOps - an update number of translog operations that will be replayed later on

sourceMetaData - meta data of the source store

Throws:

java.io.IOException

writeFileChunk

public void writeFileChunk(StoreFileMetaData fileMetaData,
                           long position,
                           BytesReference content,
                           boolean lastChunk,
                           int totalTranslogOps)
                    throws java.io.IOException

Description copied from interface: RecoveryTargetHandler

writes a partial file chunk to the target store

Specified by:

writeFileChunk in interface RecoveryTargetHandler

Throws:

java.io.IOException