org.elasticsearch.index.store.support
Class AbstractIndexStore

java.lang.Object
  org.elasticsearch.index.AbstractIndexComponent
      org.elasticsearch.index.store.support.AbstractIndexStore

All Implemented Interfaces:

CloseableIndexComponent, IndexComponent, IndexStore

Direct Known Subclasses:

ByteBufferIndexStore, FsIndexStore, RamIndexStore

public abstract class AbstractIndexStore
extends AbstractIndexComponent
implements IndexStore

Field Summary

protected IndexService	indexService
protected IndicesStore	indicesStore

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

protected

AbstractIndexStore(Index index, Settings indexSettings, IndexService indexService, IndicesStore indicesStore)

Method Summary

boolean	canDeleteUnallocated(ShardId shardId) Returns true if this shard is allocated on this node.
void	close(boolean delete) Closes the index component.
void	deleteUnallocated(ShardId shardId) Deletes this shard store since its no longer allocated.
IndicesStore	indicesStore()
StoreRateLimiting	rateLimiting() Returns the rate limiting, either of the index is explicitly configured, or the node level one (defaults to the node level one).

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.store.IndexStore

backingStoreFreeSpace, backingStoreTotalSpace, persistent, shardDirectory

Field Detail

indexService

protected final IndexService indexService

indicesStore

protected final IndicesStore indicesStore

Constructor Detail

AbstractIndexStore

protected AbstractIndexStore(Index index,
                             @IndexSettings
                             Settings indexSettings,
                             IndexService indexService,
                             IndicesStore indicesStore)

Method Detail

close

public void close(boolean delete)
           throws ElasticSearchException

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.

Throws:

ElasticSearchException

canDeleteUnallocated

public boolean canDeleteUnallocated(ShardId shardId)

Description copied from interface: IndexStore

Returns true if this shard is allocated on this node. Allocated means that it has storage files that can be deleted using IndexStore.deleteUnallocated(org.elasticsearch.index.shard.ShardId).

Specified by:

canDeleteUnallocated in interface IndexStore

deleteUnallocated

public void deleteUnallocated(ShardId shardId)
                       throws IOException

Description copied from interface: IndexStore

Deletes this shard store since its no longer allocated.

Specified by:

deleteUnallocated in interface IndexStore

Throws:

IOException

indicesStore

public IndicesStore indicesStore()

Specified by:

indicesStore in interface IndexStore

rateLimiting

public StoreRateLimiting rateLimiting()

Description copied from interface: IndexStore

Returns the rate limiting, either of the index is explicitly configured, or the node level one (defaults to the node level one).

Specified by:

rateLimiting in interface IndexStore