Package org.elasticsearch.indices.recovery

Interface RecoveryTargetHandler

All Known Implementing Classes:

RecoveryTarget, RemoteRecoveryTargetHandler

public interface RecoveryTargetHandler

Method Summary

Modifier and Type	Method	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(ReplicationTracker.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(boolean fileBasedRecovery, 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

Method Detail

prepareForTranslogOperations

void prepareForTranslogOperations(boolean fileBasedRecovery,
                                  int totalTranslogOps)
                           throws java.io.IOException

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

Parameters:

fileBasedRecovery - whether or not this call is part of an file based recovery

totalTranslogOps - total translog operations expected to be sent

Throws:

java.io.IOException

finalizeRecovery

void finalizeRecovery(long globalCheckpoint)
               throws java.io.IOException

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

Parameters:

globalCheckpoint - the global checkpoint on the recovery source

Throws:

java.io.IOException

ensureClusterStateVersion

void ensureClusterStateVersion(long clusterStateVersion)

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

handoffPrimaryContext

void handoffPrimaryContext(ReplicationTracker.PrimaryContext primaryContext)

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

Parameters:

primaryContext - the primary context from the relocation source

indexTranslogOperations

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

Index a set of translog operations on the target

Parameters:

operations - operations to index

totalTranslogOps - current number of total operations expected to be indexed

Returns:

the local checkpoint on the target shard

Throws:

java.io.IOException

receiveFileInfo

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

cleanFiles

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

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

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

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

writes a partial file chunk to the target store

Throws:

java.io.IOException