Package org.elasticsearch.indices.recovery

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, ActionListener<java.lang.Void> listener)
      The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.
      void handoffPrimaryContext​(ReplicationTracker.PrimaryContext primaryContext)
      Handoff the primary context between the relocation source and the relocation target.
      void indexTranslogOperations​(java.util.List<Translog.Operation> operations, int totalTranslogOps, long maxSeenAutoIdTimestampOnPrimary, long maxSeqNoOfUpdatesOrDeletesOnPrimary, RetentionLeases retentionLeases, ActionListener<java.lang.Long> listener)
      Index a set of translog operations on the target
      void prepareForTranslogOperations​(boolean fileBasedRecovery, int totalTranslogOps, ActionListener<java.lang.Void> listener)
      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, ActionListener<java.lang.Void> listener)
      writes a partial file chunk to the target store

    • Method Detail

      • prepareForTranslogOperations

        void prepareForTranslogOperations​(boolean fileBasedRecovery,
                                  int totalTranslogOps,
                                  ActionListener<java.lang.Void> listener)
        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

      • finalizeRecovery

        void finalizeRecovery​(long globalCheckpoint,
                      ActionListener<java.lang.Void> listener)
        The finalize request refreshes the engine now that new segments are available, enables garbage collection of tombstone files, updates the global checkpoint.
        Parameters:
        globalCheckpoint - the global checkpoint on the recovery source
        listener - the listener which will be notified when this method is completed

      • 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

        void indexTranslogOperations​(java.util.List<Translog.Operation> operations,
                             int totalTranslogOps,
                             long maxSeenAutoIdTimestampOnPrimary,
                             long maxSeqNoOfUpdatesOrDeletesOnPrimary,
                             RetentionLeases retentionLeases,
                             ActionListener<java.lang.Long> listener)
        Index a set of translog operations on the target
        Parameters:
        operations - operations to index
        totalTranslogOps - current number of total operations expected to be indexed
        maxSeenAutoIdTimestampOnPrimary - the maximum auto_id_timestamp of all append-only requests processed by the primary shard
        maxSeqNoOfUpdatesOrDeletesOnPrimary - the max seq_no of update operations (index operations overwrite Lucene) or delete ops on the primary shard when capturing these operations. This value is at least as high as the max_seq_no_of_updates on the primary was when any of these ops were processed on it.
        retentionLeases - the retention leases on the primary
        listener - a listener which will be notified with the local checkpoint on the target after these operations are successfully indexed on the target.

      • 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,
                    ActionListener<java.lang.Void> listener)
        writes a partial file chunk to the target store