org.graylog2.streams

Class StreamImpl

java.lang.Object

org.graylog2.database.PersistedImpl

org.graylog2.streams.StreamImpl

All Implemented Interfaces:

Persisted, Stream

public class StreamImpl
extends PersistedImpl
implements Stream

Representing a single stream from the streams collection. Also provides method to get all streams of this collection.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graylog2.plugin.streams.Stream

Stream.MatchingType

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMBEDDED_ALERT_CONDITIONS
static String	FIELD_ALERT_RECEIVERS
static String	FIELD_CONTENT_PACK
static String	FIELD_CREATED_AT
static String	FIELD_CREATOR_USER_ID
static String	FIELD_DEFAULT_STREAM
static String	FIELD_DESCRIPTION
static String	FIELD_DISABLED
static String	FIELD_INDEX_SET_ID
static String	FIELD_MATCHING_TYPE
static String	FIELD_OUTPUTS
static String	FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM
static String	FIELD_RULES
static String	FIELD_TITLE

Fields inherited from class org.graylog2.database.PersistedImpl

fields, id

Fields inherited from interface org.graylog2.plugin.streams.Stream

DEFAULT_EVENT_STREAM_IDS, DEFAULT_EVENTS_STREAM_ID, DEFAULT_STREAM_ID, DEFAULT_SYSTEM_EVENTS_STREAM_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
	StreamImpl(Map<String,Object> fields)
	StreamImpl(Map<String,Object> fields, IndexSet indexSet)
protected	StreamImpl(org.bson.types.ObjectId id, Map<String,Object> fields)
	StreamImpl(org.bson.types.ObjectId id, Map<String,Object> fields, List<StreamRule> streamRules, Set<Output> outputs, IndexSet indexSet)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap()
Map<String,Object>	asMap(List<StreamRule> streamRules)
Map<String,List<String>>	getAlertReceivers()
String	getContentPack()
String	getDescription()
Boolean	getDisabled()
Map<String,Validator>	getEmbeddedValidations(String key)
IndexSet	getIndexSet()
String	getIndexSetId()
Stream.MatchingType	getMatchingType()
Set<Output>	getOutputs()
boolean	getRemoveMatchesFromDefaultStream()
List<StreamRule>	getStreamRules()
String	getTitle()
Map<String,Validator>	getValidations()
boolean	isDefaultStream()
Boolean	isPaused()
void	setContentPack(String contentPack)
void	setDefaultStream(boolean defaultStream)
void	setDescription(String description)
void	setDisabled(Boolean disabled)
void	setIndexSetId(String indexSetId)
void	setMatchingType(Stream.MatchingType matchingType)
void	setRemoveMatchesFromDefaultStream(boolean removeMatchesFromDefaultStream)
void	setTitle(String title)
String	toString()

Methods inherited from class org.graylog2.database.PersistedImpl

equals, getFields, getId, getObjectId, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graylog2.plugin.streams.Stream

isDefaultStreamId

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

getFields, getId

Field Detail

FIELD_TITLE

public static final String FIELD_TITLE

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_RULES

public static final String FIELD_RULES

See Also:

Constant Field Values

FIELD_OUTPUTS

public static final String FIELD_OUTPUTS

See Also:

Constant Field Values

FIELD_CONTENT_PACK

public static final String FIELD_CONTENT_PACK

See Also:

Constant Field Values

FIELD_ALERT_RECEIVERS

public static final String FIELD_ALERT_RECEIVERS

See Also:

Constant Field Values

FIELD_DISABLED

public static final String FIELD_DISABLED

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_CREATOR_USER_ID

public static final String FIELD_CREATOR_USER_ID

See Also:

Constant Field Values

FIELD_MATCHING_TYPE

public static final String FIELD_MATCHING_TYPE

See Also:

Constant Field Values

FIELD_DEFAULT_STREAM

public static final String FIELD_DEFAULT_STREAM

See Also:

Constant Field Values

FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM

public static final String FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM

See Also:

Constant Field Values

FIELD_INDEX_SET_ID

public static final String FIELD_INDEX_SET_ID

See Also:

Constant Field Values

EMBEDDED_ALERT_CONDITIONS

public static final String EMBEDDED_ALERT_CONDITIONS

See Also:

Constant Field Values

Constructor Detail

StreamImpl

public StreamImpl(Map<String,Object> fields)

StreamImpl

public StreamImpl(Map<String,Object> fields,
                  IndexSet indexSet)

StreamImpl

protected StreamImpl(org.bson.types.ObjectId id,
                     Map<String,Object> fields)

StreamImpl

public StreamImpl(org.bson.types.ObjectId id,
                  Map<String,Object> fields,
                  List<StreamRule> streamRules,
                  Set<Output> outputs,
                  @Nullable
                  IndexSet indexSet)

Method Detail

toString

public String toString()

Overrides:

toString in class PersistedImpl

getStreamRules

public List<StreamRule> getStreamRules()

Specified by:

getStreamRules in interface Stream

getOutputs

public Set<Output> getOutputs()

Specified by:

getOutputs in interface Stream

getTitle

public String getTitle()

Specified by:

getTitle in interface Stream

getDescription

public String getDescription()

Specified by:

getDescription in interface Stream

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface Stream

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface Stream

getDisabled

public Boolean getDisabled()

Specified by:

getDisabled in interface Stream

setDisabled

public void setDisabled(Boolean disabled)

Specified by:

setDisabled in interface Stream

getContentPack

public String getContentPack()

Specified by:

getContentPack in interface Stream

setContentPack

public void setContentPack(String contentPack)

Specified by:

setContentPack in interface Stream

isPaused

public Boolean isPaused()

Specified by:

isPaused in interface Stream

asMap

public Map<String,Object> asMap(List<StreamRule> streamRules)

Specified by:

asMap in interface Stream

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface Persisted

Overrides:

asMap in class PersistedImpl

getValidations

public Map<String,Validator> getValidations()

Specified by:

getValidations in interface Persisted

getEmbeddedValidations

public Map<String,Validator> getEmbeddedValidations(String key)

Specified by:

getEmbeddedValidations in interface Persisted

getAlertReceivers

public Map<String,List<String>> getAlertReceivers()

Specified by:

getAlertReceivers in interface Stream

getMatchingType

public Stream.MatchingType getMatchingType()

Specified by:

getMatchingType in interface Stream

setMatchingType

public void setMatchingType(Stream.MatchingType matchingType)

Specified by:

setMatchingType in interface Stream

isDefaultStream

public boolean isDefaultStream()

Specified by:

isDefaultStream in interface Stream

setDefaultStream

public void setDefaultStream(boolean defaultStream)

Specified by:

setDefaultStream in interface Stream

getRemoveMatchesFromDefaultStream

public boolean getRemoveMatchesFromDefaultStream()

Specified by:

getRemoveMatchesFromDefaultStream in interface Stream

setRemoveMatchesFromDefaultStream

public void setRemoveMatchesFromDefaultStream(boolean removeMatchesFromDefaultStream)

Specified by:

setRemoveMatchesFromDefaultStream in interface Stream

getIndexSet

public IndexSet getIndexSet()

Specified by:

getIndexSet in interface Stream

getIndexSetId

public String getIndexSetId()

Specified by:

getIndexSetId in interface Stream

setIndexSetId

public void setIndexSetId(String indexSetId)

Specified by:

setIndexSetId in interface Stream