org.graylog2.streams

Interface StreamService

All Superinterfaces:

PersistedService

All Known Implementing Classes:

StreamServiceImpl

public interface StreamService
extends PersistedService

Method Summary

Modifier and Type	Method and Description
void	addAlertCondition(Stream stream, AlertCondition condition)
void	addAlertReceiver(Stream stream, String type, String name) Deprecated.
void	addOutput(Stream stream, Output output)
void	addOutputs(org.bson.types.ObjectId streamId, Collection<org.bson.types.ObjectId> outputIds)
long	count()
Stream	create(CreateStreamRequest request, String userId)
Stream	create(Map<String,Object> fields)
void	destroy(Stream stream)
AlertCondition	getAlertCondition(Stream stream, String conditionId)
List<AlertCondition>	getAlertConditions(Stream stream)
List<StreamRule>	getStreamRules(Stream stream)
Set<String>	indexSetIdsByIds(Collection<String> streamIds)
Stream	load(String id)
List<Stream>	loadAll()
List<Stream>	loadAllEnabled()
List<Stream>	loadAllWithConfiguredAlertConditions()
List<Stream>	loadAllWithIndexSet(String indexSetId)
Set<Stream>	loadByIds(Collection<String> streamIds)
void	pause(Stream stream)
void	removeAlertCondition(Stream stream, String conditionId)
void	removeAlertReceiver(Stream stream, String type, String name) Deprecated.
void	removeOutput(Stream stream, Output output)
void	removeOutputFromAllStreams(Output output)
void	resume(Stream stream)
String	save(Stream stream)
String	saveWithRulesAndOwnership(Stream stream, Collection<StreamRule> streamRules, User user)
void	updateAlertCondition(Stream stream, AlertCondition condition)

Methods inherited from interface org.graylog2.plugin.database.PersistedService

destroy, destroyAll, save, saveWithoutValidation, validate, validate, validate

Method Detail

create

Stream create(Map<String,Object> fields)

create

Stream create(CreateStreamRequest request,
              String userId)

save

String save(Stream stream)
     throws ValidationException

Throws:

ValidationException

saveWithRulesAndOwnership

String saveWithRulesAndOwnership(Stream stream,
                                 Collection<StreamRule> streamRules,
                                 User user)
                          throws ValidationException

Throws:

ValidationException

load

Stream load(String id)
     throws NotFoundException

Throws:

NotFoundException

destroy

void destroy(Stream stream)
      throws NotFoundException

Throws:

NotFoundException

loadAll

List<Stream> loadAll()

loadByIds

Set<Stream> loadByIds(Collection<String> streamIds)

indexSetIdsByIds

Set<String> indexSetIdsByIds(Collection<String> streamIds)

loadAllEnabled

List<Stream> loadAllEnabled()

count

long count()

Returns:

the total number of streams

pause

void pause(Stream stream)
    throws ValidationException

Throws:

ValidationException

resume

void resume(Stream stream)
     throws ValidationException

Throws:

ValidationException

getStreamRules

List<StreamRule> getStreamRules(Stream stream)
                         throws NotFoundException

Throws:

NotFoundException

loadAllWithConfiguredAlertConditions

List<Stream> loadAllWithConfiguredAlertConditions()

getAlertConditions

List<AlertCondition> getAlertConditions(Stream stream)

getAlertCondition

AlertCondition getAlertCondition(Stream stream,
                                 String conditionId)
                          throws NotFoundException

Throws:

NotFoundException

addAlertCondition

void addAlertCondition(Stream stream,
                       AlertCondition condition)
                throws ValidationException

Throws:

ValidationException

updateAlertCondition

void updateAlertCondition(Stream stream,
                          AlertCondition condition)
                   throws ValidationException

Throws:

ValidationException

removeAlertCondition

void removeAlertCondition(Stream stream,
                          String conditionId)

addAlertReceiver

@Deprecated
void addAlertReceiver(Stream stream,
                                  String type,
                                  String name)

Deprecated.

removeAlertReceiver

@Deprecated
void removeAlertReceiver(Stream stream,
                                     String type,
                                     String name)

Deprecated.

addOutput

void addOutput(Stream stream,
               Output output)

addOutputs

void addOutputs(org.bson.types.ObjectId streamId,
                Collection<org.bson.types.ObjectId> outputIds)

removeOutput

void removeOutput(Stream stream,
                  Output output)

removeOutputFromAllStreams

void removeOutputFromAllStreams(Output output)

loadAllWithIndexSet

List<Stream> loadAllWithIndexSet(String indexSetId)