org.elasticsearch.indices.recovery

Class RecoveryStatus

java.lang.Object

org.elasticsearch.common.util.concurrent.AbstractRefCounted

org.elasticsearch.indices.recovery.RecoveryStatus

All Implemented Interfaces:

RefCounted

public class RecoveryStatus
extends AbstractRefCounted

Constructor Summary

Constructors

Constructor and Description
RecoveryStatus(IndexShard indexShard, DiscoveryNode sourceNode, RecoveryTarget.RecoveryListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(String reason) cancel the recovery.
CancellableThreads	CancellableThreads()
protected void	cleanOpenFiles()
protected void	closeInternal()
void	fail(RecoveryFailedException e, boolean sendShardFailure) fail the recovery and call listener
org.apache.lucene.store.IndexOutput	getOpenIndexOutput(String key)
String	getTempNameForFile(String origFile) Get a temporary name for the provided file name.
IndexShard	indexShard()
long	lastAccessTime() return the last time this RecoveryStatus was used (based on System.nanoTime()
Store.LegacyChecksums	legacyChecksums()
void	markAsDone() mark the current recovery as done
org.apache.lucene.store.IndexOutput	openAndPutIndexOutput(String fileName, StoreFileMetaData metaData, Store store) Creates an IndexOutput for the given file name.
long	recoveryId()
org.apache.lucene.store.IndexOutput	removeOpenIndexOutputs(String name) remove and IndexOutput for a given file.
void	renameAllTempFiles() renames all temporary files to their true name, potentially overriding existing files
void	resetRecovery()
void	setLastAccessTime() sets the lasAccessTime flag to now
ShardId	shardId()
DiscoveryNode	sourceNode()
RecoveryState.Stage	stage()
RecoveryState	state()
Store	store()
String	toString()

Methods inherited from class org.elasticsearch.common.util.concurrent.AbstractRefCounted

alreadyClosed, decRef, getName, incRef, refCount, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryStatus

public RecoveryStatus(IndexShard indexShard,
              DiscoveryNode sourceNode,
              RecoveryTarget.RecoveryListener listener)

Method Detail

recoveryId

public long recoveryId()

shardId

public ShardId shardId()

indexShard

public IndexShard indexShard()

sourceNode

public DiscoveryNode sourceNode()

state

public RecoveryState state()

CancellableThreads

public CancellableThreads CancellableThreads()

lastAccessTime

public long lastAccessTime()

return the last time this RecoveryStatus was used (based on System.nanoTime()

setLastAccessTime

public void setLastAccessTime()

sets the lasAccessTime flag to now

store

public Store store()

stage

public RecoveryState.Stage stage()

legacyChecksums

public Store.LegacyChecksums legacyChecksums()

renameAllTempFiles

public void renameAllTempFiles()
                        throws IOException

renames all temporary files to their true name, potentially overriding existing files

Throws:

IOException

cancel

public void cancel(String reason)

cancel the recovery. calling this method will clean temporary files and release the store unless this object is in use (in which case it will be cleaned once all ongoing users call AbstractRefCounted.decRef()

if CancellableThreads() was used, the threads will be interrupted.

fail

public void fail(RecoveryFailedException e,
        boolean sendShardFailure)

fail the recovery and call listener

Parameters:

e - exception that encapsulating the failure

sendShardFailure - indicates whether to notify the master of the shard failure

markAsDone

public void markAsDone()

mark the current recovery as done

getTempNameForFile

public String getTempNameForFile(String origFile)

Get a temporary name for the provided file name.

getOpenIndexOutput

public org.apache.lucene.store.IndexOutput getOpenIndexOutput(String key)

removeOpenIndexOutputs

public org.apache.lucene.store.IndexOutput removeOpenIndexOutputs(String name)

remove and IndexOutput for a given file. It is the caller's responsibility to close it

openAndPutIndexOutput

public org.apache.lucene.store.IndexOutput openAndPutIndexOutput(String fileName,
                                                        StoreFileMetaData metaData,
                                                        Store store)
                                                          throws IOException

Creates an IndexOutput for the given file name. Note that the IndexOutput actually point at a temporary file.

Note: You can use getOpenIndexOutput(String) with the same filename to retrieve the same IndexOutput at a later stage

Throws:

IOException

resetRecovery

public void resetRecovery()
                   throws IOException

Throws:

IOException

closeInternal

protected void closeInternal()

Specified by:

closeInternal in class AbstractRefCounted

cleanOpenFiles

protected void cleanOpenFiles()

toString

public String toString()

Overrides:

toString in class Object