org.graylog2.inputs.InputService Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see .
*/
package org.graylog2.inputs;
import org.graylog2.database.NotFoundException;
import org.graylog2.plugin.database.PersistedService;
import org.graylog2.plugin.database.ValidationException;
import org.graylog2.plugin.inputs.Extractor;
import org.graylog2.plugin.inputs.MessageInput;
import org.graylog2.shared.inputs.NoSuchInputTypeException;
import java.util.List;
import java.util.Map;
public interface InputService extends PersistedService {
List all();
List allOfThisNode(String nodeId);
Input create(String id, Map fields);
Input create(Map fields);
String update(Input model) throws ValidationException;
Input find(String id) throws NotFoundException;
Input findForThisNode(String nodeId, String id) throws NotFoundException;
Input findForThisNodeOrGlobal(String nodeId, String id) throws NotFoundException;
/**
* @return the total number of inputs in the cluster (including global inputs).
*/
long totalCount();
/**
* @return the number of global inputs in the cluster.
*/
long globalCount();
/**
* @return the number of node-specific inputs in the cluster.
*/
long localCount();
/**
* @return the total number of inputs in the cluster grouped by type.
*/
Map totalCountByType();
/**
* @param nodeId the node ID to query
* @return the number of inputs on the specified node
*/
long localCountForNode(String nodeId);
/**
* @param nodeId the node ID to query
* @return the number of inputs on the specified node (including global inputs)
*/
long totalCountForNode(String nodeId);
/**
* @return the total number of extractors in the cluster (including global inputs).
*/
long totalExtractorCount();
/**
* @return the total number of extractors in the cluster (including global inputs) grouped by type.
*/
Map totalExtractorCountByType();
void addExtractor(Input input, Extractor extractor) throws ValidationException;
void addStaticField(Input input, String key, String value) throws ValidationException;
List getExtractors(Input input);
Extractor getExtractor(Input input, String extractorId) throws NotFoundException;
void updateExtractor(Input input, Extractor extractor) throws ValidationException;
void removeExtractor(Input input, String extractorId);
void removeStaticField(Input input, String key);
MessageInput getMessageInput(Input io) throws NoSuchInputTypeException;
List> getStaticFields(Input input);
}