org.graylog2.plugin

Class Message

java.lang.Object

org.graylog2.plugin.Message

All Implemented Interfaces:

Iterable<Message>, Messages

public class Message
extends Object
implements Messages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.MessageIdFunction
static class	Message.Recording

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_FULL_MESSAGE
static String	FIELD_ID
static String	FIELD_LEVEL
static String	FIELD_MESSAGE
static String	FIELD_SOURCE
static String	FIELD_STREAMS
static String	FIELD_TIMESTAMP
static com.google.common.base.Function<Message,String>	ID_FUNCTION
static com.google.common.collect.ImmutableSet<String>	RESERVED_FIELDS
static com.google.common.collect.ImmutableSet<String>	RESERVED_SETTABLE_FIELDS

Constructor Summary

Constructors

Constructor and Description
Message(Map<String,Object> fields)
Message(String message, String source, org.joda.time.DateTime timestamp)

Method Summary

Modifier and Type	Method and Description
void	addDoubleFields(Map<String,Double> fields)
void	addField(String key, Object value)
void	addFields(Map<String,Object> fields)
void	addLongFields(Map<String,Long> fields)
void	addStream(Stream stream) Assign the given stream to this message.
void	addStreams(Iterable<Stream> newStreams) Assign all of the streams to this message.
void	addStringFields(Map<String,String> fields)
Object	getField(String key)
<T> T	getFieldAs(Class<T> T, String key)
int	getFieldCount()
Set<String>	getFieldNames()
Map<String,Object>	getFields()
Iterable<Map.Entry<String,Object>>	getFieldsEntries()
boolean	getFilterOut()
String	getId()
InetAddress	getInetAddress()
boolean	getIsSourceInetAddress()
long	getJournalOffset()
String	getMessage()
String	getSource()
String	getSourceInputId()
List<String>	getStreamIds()
Set<Stream>	getStreams() Get the streams this message is currently routed to.
org.joda.time.DateTime	getTimestamp()
String	getValidationErrors()
boolean	hasField(String field)
boolean	hasRecordings()
boolean	isComplete()
Iterator<Message>	iterator()
void	recordCounter(ServerStatus serverStatus, String name, int counter)
String	recordingsAsString()
void	recordTiming(ServerStatus serverStatus, String name, long elapsedNanos)
void	removeField(String key)
boolean	removeStream(Stream stream) Remove the stream assignment from this message.
void	setFilterOut(boolean filterOut)
void	setJournalOffset(long journalOffset)
void	setSource(String source)
void	setSourceInputId(String sourceInputId)
void	setStreams(List<Stream> streams) Deprecated.
Map<String,Object>	toElasticSearchObject(com.codahale.metrics.Meter invalidTimestampMeter)
String	toString()
static boolean	validKey(String key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_MESSAGE

public static final String FIELD_MESSAGE

See Also:

Constant Field Values

FIELD_FULL_MESSAGE

public static final String FIELD_FULL_MESSAGE

See Also:

Constant Field Values

FIELD_SOURCE

public static final String FIELD_SOURCE

See Also:

Constant Field Values

FIELD_TIMESTAMP

public static final String FIELD_TIMESTAMP

See Also:

Constant Field Values

FIELD_LEVEL

public static final String FIELD_LEVEL

See Also:

Constant Field Values

FIELD_STREAMS

public static final String FIELD_STREAMS

See Also:

Constant Field Values

RESERVED_FIELDS

public static final com.google.common.collect.ImmutableSet<String> RESERVED_FIELDS

RESERVED_SETTABLE_FIELDS

public static final com.google.common.collect.ImmutableSet<String> RESERVED_SETTABLE_FIELDS

ID_FUNCTION

public static final com.google.common.base.Function<Message,String> ID_FUNCTION

Constructor Detail

Message

public Message(String message,
               String source,
               org.joda.time.DateTime timestamp)

Message

public Message(Map<String,Object> fields)

Method Detail

isComplete

public boolean isComplete()

getValidationErrors

public String getValidationErrors()

getId

public String getId()

getTimestamp

public org.joda.time.DateTime getTimestamp()

toElasticSearchObject

public Map<String,Object> toElasticSearchObject(@Nonnull
                                                com.codahale.metrics.Meter invalidTimestampMeter)

toString

public String toString()

Overrides:

toString in class Object

getMessage

public String getMessage()

getSource

public String getSource()

setSource

public void setSource(String source)

addField

public void addField(String key,
                     Object value)

validKey

public static boolean validKey(String key)

addFields

public void addFields(Map<String,Object> fields)

addStringFields

public void addStringFields(Map<String,String> fields)

addLongFields

public void addLongFields(Map<String,Long> fields)

addDoubleFields

public void addDoubleFields(Map<String,Double> fields)

removeField

public void removeField(String key)

getFieldAs

public <T> T getFieldAs(Class<T> T,
                        String key)
                 throws ClassCastException

Throws:

ClassCastException

getField

public Object getField(String key)

getFields

public Map<String,Object> getFields()

getFieldsEntries

public Iterable<Map.Entry<String,Object>> getFieldsEntries()

getFieldCount

public int getFieldCount()

hasField

public boolean hasField(String field)

getFieldNames

public Set<String> getFieldNames()

setStreams

@Deprecated
public void setStreams(List<Stream> streams)

Deprecated.

getStreams

public Set<Stream> getStreams()

Get the streams this message is currently routed to.

Returns:

an immutable copy of the current set of assigned streams, empty if no streams have been assigned

addStream

public void addStream(Stream stream)

Assign the given stream to this message.

Parameters:

stream - the stream to route this message into

addStreams

public void addStreams(Iterable<Stream> newStreams)

Assign all of the streams to this message.

Parameters:

newStreams - an iterable of Stream objects

removeStream

public boolean removeStream(Stream stream)

Remove the stream assignment from this message.

Parameters:

stream - the stream assignment to remove this message from

Returns:

true if this message was assigned to the stream

getStreamIds

public List<String> getStreamIds()

setFilterOut

public void setFilterOut(boolean filterOut)

getFilterOut

public boolean getFilterOut()

setSourceInputId

public void setSourceInputId(String sourceInputId)

getSourceInputId

public String getSourceInputId()

getIsSourceInetAddress

public boolean getIsSourceInetAddress()

getInetAddress

public InetAddress getInetAddress()

setJournalOffset

public void setJournalOffset(long journalOffset)

getJournalOffset

public long getJournalOffset()

recordTiming

public void recordTiming(ServerStatus serverStatus,
                         String name,
                         long elapsedNanos)

recordCounter

public void recordCounter(ServerStatus serverStatus,
                          String name,
                          int counter)

recordingsAsString

public String recordingsAsString()

hasRecordings

public boolean hasRecordings()

iterator

public Iterator<Message> iterator()

Specified by:

iterator in interface Iterable<Message>