org.elasticsearch.index.gateway.fs
Class FsIndexShardGateway

java.lang.Object
  extended by org.elasticsearch.index.shard.AbstractIndexShardComponent
      extended by org.elasticsearch.index.gateway.fs.FsIndexShardGateway
All Implemented Interfaces:
IndexShardGateway, IndexShardComponent, CloseableIndexComponent

public class FsIndexShardGateway
extends AbstractIndexShardComponent
implements IndexShardGateway


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.gateway.IndexShardGateway
IndexShardGateway.RecoveryStatus, IndexShardGateway.Snapshot, IndexShardGateway.SnapshotStatus
 
Field Summary
 
Fields inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent
componentSettings, indexSettings, logger, shardId
 
Constructor Summary
FsIndexShardGateway(ShardId shardId, Settings indexSettings, ThreadPool threadPool, FsIndexGateway fsIndexGateway, IndexShard indexShard, Store store)
           
 
Method Summary
 void close(boolean delete)
          Closes the index component.
 IndexShardGateway.RecoveryStatus recover()
          Recovers the state of the shard from the gateway.
 boolean requiresSnapshotScheduling()
          Returns true if this gateway requires scheduling management for snapshot operations.
 IndexShardGateway.SnapshotStatus snapshot(IndexShardGateway.Snapshot snapshot)
          Snapshots the given shard into the gateway.
 java.lang.String toString()
           
 
Methods inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent
indexSettings, managementGroupName, nodeName, shardId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.elasticsearch.index.shard.IndexShardComponent
indexSettings, shardId
 

Constructor Detail

FsIndexShardGateway

@Inject
public FsIndexShardGateway(ShardId shardId,
                                  @IndexSettings
                                  Settings indexSettings,
                                  ThreadPool threadPool,
                                  FsIndexGateway fsIndexGateway,
                                  IndexShard indexShard,
                                  Store store)
Method Detail

requiresSnapshotScheduling

public boolean requiresSnapshotScheduling()
Description copied from interface: IndexShardGateway
Returns true if this gateway requires scheduling management for snapshot operations.

Specified by:
requiresSnapshotScheduling in interface IndexShardGateway

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

close

public void close(boolean delete)
Description copied from interface: CloseableIndexComponent
Closes the index component. A boolean indicating if its part of an actual index deletion or not is passed.

Specified by:
close in interface CloseableIndexComponent
Parameters:
delete - true if the index is being deleted.

recover

public IndexShardGateway.RecoveryStatus recover()
                                         throws IndexShardGatewayRecoveryException
Description copied from interface: IndexShardGateway
Recovers the state of the shard from the gateway.

Specified by:
recover in interface IndexShardGateway
Throws:
IndexShardGatewayRecoveryException

snapshot

public IndexShardGateway.SnapshotStatus snapshot(IndexShardGateway.Snapshot snapshot)
Description copied from interface: IndexShardGateway
Snapshots the given shard into the gateway.

Specified by:
snapshot in interface IndexShardGateway