org.graylog2.indexer

Interface IndexSetRegistry

All Superinterfaces:

Iterable<IndexSet>

All Known Implementing Classes:

MongoIndexSetRegistry

public interface IndexSetRegistry
extends Iterable<IndexSet>

Method Summary

Modifier and Type	Method and Description
Optional<IndexSet>	get(String indexSetId) Returns the IndexSet for the given ID.
Set<IndexSet>	getAll() Returns a list of all IndexSet instances.
IndexSet	getDefault() Returns the IndexSet that is marked as default.
Optional<IndexSet>	getForIndex(String index) Returns the IndexSet for the given index.
Set<IndexSet>	getForIndices(Collection<String> indices) Returns the IndexSets for the given indices.
String[]	getIndexWildcards() Returns the list of all index wildcards.
String[]	getManagedIndices() Returns a list of all managed indices.
String[]	getWriteIndexAliases() Returns the list of all write index aliases.
boolean	isCurrentWriteIndex(String index) Checks if the given index is a current write index in any IndexSet.
boolean	isCurrentWriteIndexAlias(String indexName) Checks if the given index name is a current write index alias in any IndexSet.
Map<String,Boolean>	isManagedIndex(Collection<String> indices) Checks if the given indices are managed by any index set.
boolean	isManagedIndex(String index) Checks if the given index is managed by any index set.
boolean	isUp() Checks if all deflector aliases exist.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getAll

Set<IndexSet> getAll()

Returns a list of all IndexSet instances.

Returns:

list of index sets

get

Optional<IndexSet> get(String indexSetId)

Returns the IndexSet for the given ID.

Parameters:

indexSetId - ID of the index set

Returns:

index set

getForIndex

Optional<IndexSet> getForIndex(String index)

Returns the IndexSet for the given index.

Parameters:

index - name of the index

Returns:

index set that manages the given index

getForIndices

Set<IndexSet> getForIndices(Collection<String> indices)

Returns the IndexSets for the given indices.

Parameters:

indices - Collection with the name of the indicies

Returns:

Set of index sets which manages the given indices

getDefault

IndexSet getDefault()

Returns the IndexSet that is marked as default. Throws an IllegalStateException if the default index set does not exist.

Returns:

the default index set

getManagedIndices

String[] getManagedIndices()

Returns a list of all managed indices.

Returns:

list of managed indices

isManagedIndex

boolean isManagedIndex(String index)

Checks if the given index is managed by any index set.

Parameters:

index - the index name to check

Returns:

true when index is managed by any index set, false otherwise

isManagedIndex

Map<String,Boolean> isManagedIndex(Collection<String> indices)

Checks if the given indices are managed by any index set.

Parameters:

indices - the index names to check

Returns:

true when index is managed by any index set, false otherwise

getIndexWildcards

String[] getIndexWildcards()

Returns the list of all index wildcards.

Returns:

list of wildcards

getWriteIndexAliases

String[] getWriteIndexAliases()

Returns the list of all write index aliases.

Returns:

list of names

isUp

boolean isUp()

Checks if all deflector aliases exist.

Returns:

if all aliases exist

isCurrentWriteIndexAlias

boolean isCurrentWriteIndexAlias(String indexName)

Checks if the given index name is a current write index alias in any IndexSet.

Parameters:

indexName - the name of the index to check

Returns:

true when given index name is a current write index, false otherwise

isCurrentWriteIndex

boolean isCurrentWriteIndex(String index)
                     throws TooManyAliasesException

Checks if the given index is a current write index in any IndexSet.

Parameters:

index - the index name to check

Returns:

true when index is a current write index, false otherwise

Throws:

TooManyAliasesException