org.graylog2.indexer.indexset.IndexSetService 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.indexset;
import org.bson.types.ObjectId;
import org.mongojack.DBQuery;
import java.util.List;
import java.util.Optional;
import java.util.Set;
public interface IndexSetService {
/**
* Retrieve index set with the given ID.
*
* @param id The ID of the index set.
* @return A filled {@link Optional} with the retrieved index set, an empty {@link Optional} otherwise.
*/
Optional get(ObjectId id);
/**
* @see #get(ObjectId)
*/
Optional get(String id);
/**
* Retrieve the default index set.
*
* Throws an {@link IllegalStateException} if the default index set does not exist.
*
* @return A filled {@link Optional} with the default index set, an empty {@link Optional} if there is no default.
*/
IndexSetConfig getDefault();
/**
* Retrieve an index set based on the given {@link DBQuery.Query}.
*
* @return index set
*/
Optional findOne(DBQuery.Query query);
/**
* Retrieve all index sets.
*
* @return All index sets.
*/
List findAll();
/**
* Retrieve all index sets which match one of the specified IDs.
*
* @return All index sets matching one of the given IDs.
*/
List findByIds(Set ids);
List findMany(DBQuery.Query query);
/**
* Retrieve a paginated set of index set.
*
* @param indexSetIds List of inde set ids to return
* @param limit Maximum number of index sets
* @param skip Number of index sets to skip
* @return Paginated index sets
*/
List findPaginated(Set indexSetIds, int limit, int skip);
/**
* Save the given index set.
*
* @param indexSetConfig The index set to save.
* @return The {@link IndexSetConfig} instance of the saved index set (with non-null {@code id} field).
*/
IndexSetConfig save(IndexSetConfig indexSetConfig);
/**
* Delete the index set with the given ID.
*
* @param id The ID of the index set.
* @return The number of deleted index sets.
*/
int delete(ObjectId id);
/**
* @see #delete(ObjectId)
*/
int delete(String id);
}