Package org.elasticsearch.gateway

Class MetaStateService

java.lang.Object

org.elasticsearch.gateway.MetaStateService

public class MetaStateService
extends Object

Handles writing and loading Manifest, MetaData and IndexMetaData

Field Summary

Fields

Modifier and Type	Field	Description
protected MetaDataStateFormat<IndexMetaData>	INDEX_META_DATA_FORMAT
protected MetaDataStateFormat<Manifest>	MANIFEST_FORMAT
protected MetaDataStateFormat<MetaData>	META_DATA_FORMAT

Constructor Summary

Constructors

Constructor	Description
MetaStateService(NodeEnvironment nodeEnv, NamedXContentRegistry namedXContentRegistry)

Method Summary

Modifier and Type	Method	Description
void	cleanupIndex(Index index, long currentGeneration)	Removes old state files in index directory.
IndexMetaData	loadIndexState(Index index)	Loads the index state for the provided index name, returning null if doesn't exists.
Manifest	loadManifestOrEmpty()	Loads Manifest file from disk, returns Manifest.empty() if there is no manifest file.
void	writeGlobalStateAndUpdateManifest(String reason, MetaData metaData)	Writes global metadata and updates manifest file accordingly.
long	writeIndex(String reason, IndexMetaData indexMetaData)	Writes the index state.
void	writeIndexAndUpdateManifest(String reason, IndexMetaData metaData)	Writes index metadata and updates manifest file accordingly.
void	writeManifestAndCleanup(String reason, Manifest manifest)	Writes manifest file (represented by Manifest) to disk and performs cleanup of old manifest state file if the write succeeds or newly created manifest state if the write fails.

Methods inherited from class java.lang.Object

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

Field Detail

META_DATA_FORMAT

protected MetaDataStateFormat<MetaData> META_DATA_FORMAT

INDEX_META_DATA_FORMAT

protected MetaDataStateFormat<IndexMetaData> INDEX_META_DATA_FORMAT

MANIFEST_FORMAT

protected MetaDataStateFormat<Manifest> MANIFEST_FORMAT

Constructor Detail

MetaStateService

public MetaStateService(NodeEnvironment nodeEnv,
                        NamedXContentRegistry namedXContentRegistry)

Method Detail

loadIndexState

@Nullable
public IndexMetaData loadIndexState(Index index)
                             throws IOException

Loads the index state for the provided index name, returning null if doesn't exists.

Throws:

IOException

loadManifestOrEmpty

public Manifest loadManifestOrEmpty()
                             throws IOException

Loads Manifest file from disk, returns Manifest.empty() if there is no manifest file.

Throws:

IOException

writeManifestAndCleanup

public void writeManifestAndCleanup(String reason,
                                    Manifest manifest)
                             throws WriteStateException

Writes manifest file (represented by Manifest) to disk and performs cleanup of old manifest state file if the write succeeds or newly created manifest state if the write fails.

Throws:

WriteStateException - if exception when writing state occurs. See also WriteStateException.isDirty()

writeIndex

public long writeIndex(String reason,
                       IndexMetaData indexMetaData)
                throws WriteStateException

Writes the index state.

This method is public for testing purposes.

Throws:

WriteStateException - if exception when writing state occurs. WriteStateException.isDirty() will always return false, because new index state file is not yet referenced by manifest file.

cleanupIndex

public void cleanupIndex(Index index,
                         long currentGeneration)

Removes old state files in index directory.

Parameters:

index - index to perform clean up on.

currentGeneration - current state generation to keep in the index directory.

writeIndexAndUpdateManifest

public void writeIndexAndUpdateManifest(String reason,
                                        IndexMetaData metaData)
                                 throws IOException

Writes index metadata and updates manifest file accordingly. Used by tests.

Throws:

IOException

writeGlobalStateAndUpdateManifest

public void writeGlobalStateAndUpdateManifest(String reason,
                                              MetaData metaData)
                                       throws IOException

Writes global metadata and updates manifest file accordingly. Used by tests.

Throws:

IOException