Module org.elasticsearch.server

Package org.elasticsearch.repositories

Class SnapshotShardContext

java.lang.Object

org.elasticsearch.action.DelegatingActionListener<ShardSnapshotResult,ShardSnapshotResult>

org.elasticsearch.repositories.SnapshotShardContext

All Implemented Interfaces:

ActionListener<ShardSnapshotResult>

Direct Known Subclasses:

LocalPrimarySnapshotShardContext

public abstract class SnapshotShardContext
extends DelegatingActionListener<ShardSnapshotResult,ShardSnapshotResult>

Context holding the state for creating a shard snapshot via Repository.snapshotShard(SnapshotShardContext). Wraps a Engine.IndexCommitRef that is released once this instances is completed by invoking either its onResponse(ShardSnapshotResult) or DelegatingActionListener.onFailure(Exception) callback.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapshotShardContext.FileReader
static class	SnapshotShardContext.IndexInputFileReader

Field Summary

Fields inherited from class org.elasticsearch.action.DelegatingActionListener

delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SnapshotShardContext(SnapshotId snapshotId, IndexId indexId, String shardStateIdentifier, IndexShardSnapshotStatus snapshotStatus, IndexVersion repositoryMetaVersion, long snapshotStartTime, ActionListener<ShardSnapshotResult> listener)

Method Summary

Modifier and Type	Method	Description
void	addListener(ActionListener<ShardSnapshotResult> listener)
abstract boolean	assertFileContentsMatchHash(BlobStoreIndexShardSnapshot.FileInfo fileInfo)
abstract void	failStoreIfCorrupted(Exception e)
abstract Collection<String>	fileNames()
abstract SnapshotShardContext.FileReader	fileReader(String file, StoreFileMetadata metadata)
IndexVersion	getRepositoryMetaVersion()
IndexId	indexId()
abstract boolean	isSearchableSnapshot()
abstract Store.MetadataSnapshot	metadataSnapshot()
void	onResponse(ShardSnapshotResult result)	Complete this listener with a successful (or at least, non-exceptional) response.
abstract ShardId	shardId()
SnapshotId	snapshotId()
long	snapshotStartTime()
String	stateIdentifier()
IndexShardSnapshotStatus	status()

Methods inherited from class org.elasticsearch.action.DelegatingActionListener

onFailure, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateFailureAndWrap, delegateFailureIgnoreResponseAndWrap, delegateResponse, map, safeMap

Constructor Details

SnapshotShardContext

protected SnapshotShardContext(SnapshotId snapshotId,
 IndexId indexId,
 @Nullable
 String shardStateIdentifier,
 IndexShardSnapshotStatus snapshotStatus,
 IndexVersion repositoryMetaVersion,
 long snapshotStartTime,
 ActionListener<ShardSnapshotResult> listener)

Method Details

snapshotId

public SnapshotId snapshotId()

indexId

public IndexId indexId()

stateIdentifier

@Nullable
public String stateIdentifier()

status

public IndexShardSnapshotStatus status()

getRepositoryMetaVersion

public IndexVersion getRepositoryMetaVersion()

snapshotStartTime

public long snapshotStartTime()

onResponse

public void onResponse(ShardSnapshotResult result)

Description copied from interface: ActionListener

Complete this listener with a successful (or at least, non-exceptional) response.

shardId

public abstract ShardId shardId()

isSearchableSnapshot

public abstract boolean isSearchableSnapshot()

metadataSnapshot

public abstract Store.MetadataSnapshot metadataSnapshot()

fileNames

public abstract Collection<String> fileNames()

assertFileContentsMatchHash

public abstract boolean assertFileContentsMatchHash(BlobStoreIndexShardSnapshot.FileInfo fileInfo)

failStoreIfCorrupted

public abstract void failStoreIfCorrupted(Exception e)

fileReader

public abstract SnapshotShardContext.FileReader fileReader(String file,
 StoreFileMetadata metadata)
                                                    throws IOException

Throws:

IOException

addListener

public void addListener(ActionListener<ShardSnapshotResult> listener)