Package org.elasticsearch.repositories

Class FilterRepository

java.lang.Object

org.elasticsearch.repositories.FilterRepository

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, Repository

public class FilterRepository
extends java.lang.Object
implements Repository

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.repositories.Repository

Repository.Factory

Constructor Summary

Constructors

Constructor	Description
FilterRepository(Repository in)

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(LifecycleListener listener)
void	close()
void	deleteSnapshot(SnapshotId snapshotId, long repositoryStateId)	Deletes snapshot
void	endVerification(java.lang.String verificationToken)	Called at the end of repository verification process.
SnapshotInfo	finalizeSnapshot(SnapshotId snapshotId, java.util.List<IndexId> indices, long startTime, java.lang.String failure, int totalShards, java.util.List<SnapshotShardFailure> shardFailures, long repositoryStateId, boolean includeGlobalState)	Finalizes snapshotting process
RepositoryMetaData	getMetadata()	Returns metadata about this repository.
RepositoryData	getRepositoryData()	Returns a RepositoryData to describe the data in the repository, including the snapshots and the indices across all snapshots found in the repository.
long	getRestoreThrottleTimeInNanos()	Returns restore throttle time in nanoseconds
IndexShardSnapshotStatus	getShardSnapshotStatus(SnapshotId snapshotId, Version version, IndexId indexId, ShardId shardId)	Retrieve shard snapshot status for the stored snapshot
MetaData	getSnapshotGlobalMetaData(SnapshotId snapshotId)	Returns global metadata associated with the snapshot.
IndexMetaData	getSnapshotIndexMetaData(SnapshotId snapshotId, IndexId index)	Returns the index metadata associated with the snapshot.
SnapshotInfo	getSnapshotInfo(SnapshotId snapshotId)	Reads snapshot description from repository.
long	getSnapshotThrottleTimeInNanos()	Returns snapshot throttle time in nanoseconds
void	initializeSnapshot(SnapshotId snapshotId, java.util.List<IndexId> indices, MetaData metaData)	Starts snapshotting process
boolean	isReadOnly()	Returns true if the repository supports only read operations
Lifecycle.State	lifecycleState()
void	removeLifecycleListener(LifecycleListener listener)
void	restoreShard(IndexShard shard, SnapshotId snapshotId, Version version, IndexId indexId, ShardId snapshotShardId, RecoveryState recoveryState)	Restores snapshot of the shard.
void	snapshotShard(IndexShard shard, Store store, SnapshotId snapshotId, IndexId indexId, org.apache.lucene.index.IndexCommit snapshotIndexCommit, IndexShardSnapshotStatus snapshotStatus)	Creates a snapshot of the shard based on the index commit point.
void	start()
java.lang.String	startVerification()	Verifies repository on the master node and returns the verification token.
void	stop()
void	verify(java.lang.String verificationToken, DiscoveryNode localNode)	Verifies repository settings on data node.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterRepository

public FilterRepository(Repository in)

Method Detail

getMetadata

public RepositoryMetaData getMetadata()

Description copied from interface: Repository

Returns metadata about this repository.

Specified by:

getMetadata in interface Repository

getSnapshotInfo

public SnapshotInfo getSnapshotInfo(SnapshotId snapshotId)

Description copied from interface: Repository

Reads snapshot description from repository.

Specified by:

getSnapshotInfo in interface Repository

Parameters:

snapshotId - snapshot id

Returns:

information about snapshot

getSnapshotGlobalMetaData

public MetaData getSnapshotGlobalMetaData(SnapshotId snapshotId)

Description copied from interface: Repository

Returns global metadata associated with the snapshot.

Specified by:

getSnapshotGlobalMetaData in interface Repository

Parameters:

snapshotId - the snapshot id to load the global metadata from

Returns:

the global metadata about the snapshot

getSnapshotIndexMetaData

public IndexMetaData getSnapshotIndexMetaData(SnapshotId snapshotId,
                                              IndexId index)
                                       throws java.io.IOException

Description copied from interface: Repository

Returns the index metadata associated with the snapshot.

Specified by:

getSnapshotIndexMetaData in interface Repository

Parameters:

snapshotId - the snapshot id to load the index metadata from

index - the IndexId to load the metadata from

Returns:

the index metadata about the given index for the given snapshot

Throws:

java.io.IOException

getRepositoryData

public RepositoryData getRepositoryData()

Description copied from interface: Repository

Returns a RepositoryData to describe the data in the repository, including the snapshots and the indices across all snapshots found in the repository. Throws a RepositoryException if there was an error in reading the data.

Specified by:

getRepositoryData in interface Repository

initializeSnapshot

public void initializeSnapshot(SnapshotId snapshotId,
                               java.util.List<IndexId> indices,
                               MetaData metaData)

Description copied from interface: Repository

Starts snapshotting process

Specified by:

initializeSnapshot in interface Repository

Parameters:

snapshotId - snapshot id

indices - list of indices to be snapshotted

metaData - cluster metadata

finalizeSnapshot

public SnapshotInfo finalizeSnapshot(SnapshotId snapshotId,
                                     java.util.List<IndexId> indices,
                                     long startTime,
                                     java.lang.String failure,
                                     int totalShards,
                                     java.util.List<SnapshotShardFailure> shardFailures,
                                     long repositoryStateId,
                                     boolean includeGlobalState)

Description copied from interface: Repository

Finalizes snapshotting process

This method is called on master after all shards are snapshotted.

Specified by:

finalizeSnapshot in interface Repository

Parameters:

snapshotId - snapshot id

indices - list of indices in the snapshot

startTime - start time of the snapshot

failure - global failure reason or null

totalShards - total number of shards

shardFailures - list of shard failures

repositoryStateId - the unique id identifying the state of the repository when the snapshot began

includeGlobalState - include cluster global state

Returns:

snapshot description

deleteSnapshot

public void deleteSnapshot(SnapshotId snapshotId,
                           long repositoryStateId)

Description copied from interface: Repository

Deletes snapshot

Specified by:

deleteSnapshot in interface Repository

Parameters:

snapshotId - snapshot id

repositoryStateId - the unique id identifying the state of the repository when the snapshot deletion began

getSnapshotThrottleTimeInNanos

public long getSnapshotThrottleTimeInNanos()

Description copied from interface: Repository

Returns snapshot throttle time in nanoseconds

Specified by:

getSnapshotThrottleTimeInNanos in interface Repository

getRestoreThrottleTimeInNanos

public long getRestoreThrottleTimeInNanos()

Description copied from interface: Repository

Returns restore throttle time in nanoseconds

Specified by:

getRestoreThrottleTimeInNanos in interface Repository

startVerification

public java.lang.String startVerification()

Description copied from interface: Repository

Verifies repository on the master node and returns the verification token.

If the verification token is not null, it's passed to all data nodes for verification. If it's null - no additional verification is required

Specified by:

startVerification in interface Repository

Returns:

verification token that should be passed to all Index Shard Repositories for additional verification or null

endVerification

public void endVerification(java.lang.String verificationToken)

Description copied from interface: Repository

Called at the end of repository verification process.

This method should perform all necessary cleanup of the temporary files created in the repository

Specified by:

endVerification in interface Repository

Parameters:

verificationToken - verification request generated by Repository.startVerification() command

verify

public void verify(java.lang.String verificationToken,
                   DiscoveryNode localNode)

Description copied from interface: Repository

Verifies repository settings on data node.

Specified by:

verify in interface Repository

Parameters:

verificationToken - value returned by Repository.startVerification()

localNode - the local node information, for inclusion in verification errors

isReadOnly

public boolean isReadOnly()

Description copied from interface: Repository

Returns true if the repository supports only read operations

Specified by:

isReadOnly in interface Repository

Returns:

true if the repository is read/only

snapshotShard

public void snapshotShard(IndexShard shard,
                          Store store,
                          SnapshotId snapshotId,
                          IndexId indexId,
                          org.apache.lucene.index.IndexCommit snapshotIndexCommit,
                          IndexShardSnapshotStatus snapshotStatus)

Description copied from interface: Repository

Creates a snapshot of the shard based on the index commit point.

The index commit point can be obtained by using Engine.acquireLastIndexCommit(boolean) method. Repository implementations shouldn't release the snapshot index commit point. It is done by the method caller.

As snapshot process progresses, implementation of this method should update IndexShardSnapshotStatus object and check IndexShardSnapshotStatus.isAborted() to see if the snapshot process should be aborted.

Specified by:

snapshotShard in interface Repository

Parameters:

shard - shard to be snapshotted

store - store to be snapshotted

snapshotId - snapshot id

indexId - id for the index being snapshotted

snapshotIndexCommit - commit point

snapshotStatus - snapshot status

restoreShard

public void restoreShard(IndexShard shard,
                         SnapshotId snapshotId,
                         Version version,
                         IndexId indexId,
                         ShardId snapshotShardId,
                         RecoveryState recoveryState)

Description copied from interface: Repository

Restores snapshot of the shard.

The index can be renamed on restore, hence different shardId and snapshotShardId are supplied.

Specified by:

restoreShard in interface Repository

Parameters:

shard - the shard to restore the index into

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

indexId - id of the index in the repository from which the restore is occurring

snapshotShardId - shard id (in the snapshot)

recoveryState - recovery state

getShardSnapshotStatus

public IndexShardSnapshotStatus getShardSnapshotStatus(SnapshotId snapshotId,
                                                       Version version,
                                                       IndexId indexId,
                                                       ShardId shardId)

Description copied from interface: Repository

Retrieve shard snapshot status for the stored snapshot

Specified by:

getShardSnapshotStatus in interface Repository

Parameters:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

indexId - the snapshotted index id for the shard to get status for

shardId - shard id

Returns:

snapshot status

lifecycleState

public Lifecycle.State lifecycleState()

Specified by:

lifecycleState in interface LifecycleComponent

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Specified by:

addLifecycleListener in interface LifecycleComponent

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Specified by:

removeLifecycleListener in interface LifecycleComponent

start

public void start()

Specified by:

start in interface LifecycleComponent

stop

public void stop()

Specified by:

stop in interface LifecycleComponent

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable