org.graylog2.streams.StreamService 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.streams;
import org.bson.types.ObjectId;
import org.graylog2.database.NotFoundException;
import org.graylog2.plugin.alarms.AlertCondition;
import org.graylog2.plugin.database.PersistedService;
import org.graylog2.plugin.database.ValidationException;
import org.graylog2.plugin.database.users.User;
import org.graylog2.plugin.streams.Output;
import org.graylog2.plugin.streams.Stream;
import org.graylog2.plugin.streams.StreamRule;
import org.graylog2.rest.resources.streams.requests.CreateStreamRequest;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
public interface StreamService extends PersistedService {
Stream create(Map fields);
Stream create(CreateStreamRequest request, String userId);
String save(Stream stream) throws ValidationException;
String saveWithRulesAndOwnership(Stream stream, Collection streamRules, User user) throws ValidationException;
Stream load(String id) throws NotFoundException;
void destroy(Stream stream) throws NotFoundException;
List loadAll();
Set loadByIds(Collection streamIds);
Set indexSetIdsByIds(Collection streamIds);
List loadAllEnabled();
/**
* @return the total number of streams
*/
long count();
void pause(Stream stream) throws ValidationException;
void resume(Stream stream) throws ValidationException;
List getStreamRules(Stream stream) throws NotFoundException;
List loadAllWithConfiguredAlertConditions();
List getAlertConditions(Stream stream);
AlertCondition getAlertCondition(Stream stream, String conditionId) throws NotFoundException;
void addAlertCondition(Stream stream, AlertCondition condition) throws ValidationException;
void updateAlertCondition(Stream stream, AlertCondition condition) throws ValidationException;
void removeAlertCondition(Stream stream, String conditionId);
@Deprecated
void addAlertReceiver(Stream stream, String type, String name);
@Deprecated
void removeAlertReceiver(Stream stream, String type, String name);
void addOutput(Stream stream, Output output);
void addOutputs(ObjectId streamId, Collection outputIds);
void removeOutput(Stream stream, Output output);
void removeOutputFromAllStreams(Output output);
List loadAllWithIndexSet(String indexSetId);
}