org.graylog2.indexer.IndexSetRegistry Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog2.indexer;
import org.graylog2.indexer.indices.TooManyAliasesException;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
public interface IndexSetRegistry extends Iterable {
/**
* Returns a list of all {@link IndexSet} instances.
*
* @return list of index sets
*/
Set getAll();
/**
* Returns the {@link IndexSet} for the given ID.
*
* @param indexSetId ID of the index set
* @return index set
*/
Optional get(String indexSetId);
/**
* Returns the {@link IndexSet} for the given index.
*
* @param index name of the index
* @return index set that manages the given index
*/
Optional getForIndex(String index);
/**
* Returns the {@link IndexSet}s for the given indices.
*
* @param indices Collection with the name of the indicies
* @return Set of index sets which manages the given indices
*/
Set getForIndices(Collection indices);
/**
* Returns the {@link IndexSet} that is marked as default.
*
* Throws an {@link IllegalStateException} if the default index set does not exist.
*
* @return the default index set
*/
IndexSet getDefault();
/**
* Returns a list of all managed indices.
*
* @return list of managed indices
*/
String[] getManagedIndices();
/**
* Checks if the given index is managed by any index set.
*
* @param index the index name to check
* @return true when index is managed by any index set, false otherwise
*/
boolean isManagedIndex(String index);
/**
* Checks if the given indices are managed by any index set.
*
* @param indices the index names to check
* @return true when index is managed by any index set, false otherwise
*/
Map isManagedIndex(Collection indices);
/**
* Returns the list of all index wildcards.
*
* @return list of wildcards
*/
String[] getIndexWildcards();
/**
* Returns the list of all write index aliases.
*
* @return list of names
*/
String[] getWriteIndexAliases();
/**
* Checks if all deflector aliases exist.
*
* @return if all aliases exist
*/
boolean isUp();
/**
* Checks if the given index name is a current write index alias in any {@link IndexSet}.
*
* @param indexName the name of the index to check
* @return true when given index name is a current write index, false otherwise
*/
boolean isCurrentWriteIndexAlias(String indexName);
/**
* Checks if the given index is a current write index in any {@link IndexSet}.
*
* @param index the index name to check
* @return true when index is a current write index, false otherwise
* @throws TooManyAliasesException
*/
boolean isCurrentWriteIndex(String index) throws TooManyAliasesException;
}