Package org.elasticsearch.plugins
Interface IndexStorePlugin
public interface IndexStorePlugin
A plugin that provides alternative directory implementations.
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
IndexStorePlugin.DirectoryFactory
An interface that describes how to create a new directory instance per shard.static interface
IndexStorePlugin.IndexFoldersDeletionListener
IndexStorePlugin.IndexFoldersDeletionListener
are invoked before the folders of a shard or an index are deleted from disk.static interface
IndexStorePlugin.RecoveryStateFactory
An interface that allows to create a newRecoveryState
per shard.static interface
IndexStorePlugin.SnapshotCommitSupplier
An interface that allows plugins to override theIndexCommit
of which a snapshot is taken. -
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,IndexStorePlugin.DirectoryFactory>
getDirectoryFactories()
TheIndexStorePlugin.DirectoryFactory
mappings for this plugin.default java.util.List<IndexStorePlugin.IndexFoldersDeletionListener>
getIndexFoldersDeletionListeners()
TheIndexStorePlugin.IndexFoldersDeletionListener
listeners for this plugin.default java.util.Map<java.lang.String,IndexStorePlugin.RecoveryStateFactory>
getRecoveryStateFactories()
TheIndexStorePlugin.RecoveryStateFactory
mappings for this plugin.default java.util.Map<java.lang.String,IndexStorePlugin.SnapshotCommitSupplier>
getSnapshotCommitSuppliers()
TheIndexStorePlugin.SnapshotCommitSupplier
mappings for this plugin.
-
Method Details
-
getDirectoryFactories
java.util.Map<java.lang.String,IndexStorePlugin.DirectoryFactory> getDirectoryFactories()TheIndexStorePlugin.DirectoryFactory
mappings for this plugin. When an index is created the store type settingIndexModule.INDEX_STORE_TYPE_SETTING
on the index will be examined and either use the default or a built-in type, or looked up among all the directory factories fromIndexStorePlugin
plugins.- Returns:
- a map from store type to an directory factory
-
getRecoveryStateFactories
default java.util.Map<java.lang.String,IndexStorePlugin.RecoveryStateFactory> getRecoveryStateFactories()TheIndexStorePlugin.RecoveryStateFactory
mappings for this plugin. When an index is created the recovery type settingIndexModule.INDEX_RECOVERY_TYPE_SETTING
on the index will be examined and either use the default or looked up among all the recovery state factories fromIndexStorePlugin
plugins.- Returns:
- a map from recovery type to an recovery state factory
-
getIndexFoldersDeletionListeners
default java.util.List<IndexStorePlugin.IndexFoldersDeletionListener> getIndexFoldersDeletionListeners()TheIndexStorePlugin.IndexFoldersDeletionListener
listeners for this plugin. When the folders of an index or a shard are deleted from disk, these listeners are invoked before the deletion happens in order to allow plugin to clean up any resources if needed.- Returns:
- a list of
IndexStorePlugin.IndexFoldersDeletionListener
listeners
-
getSnapshotCommitSuppliers
default java.util.Map<java.lang.String,IndexStorePlugin.SnapshotCommitSupplier> getSnapshotCommitSuppliers()TheIndexStorePlugin.SnapshotCommitSupplier
mappings for this plugin. When an index is created the store type settingIndexModule.INDEX_STORE_TYPE_SETTING
on the index will determine whether the snapshot commit supplier should be overridden and, if so, which override to use.- Returns:
- a collection of snapshot commit suppliers, keyed by the value of
IndexModule.INDEX_STORE_TYPE_SETTING
.
-