org.graylog2.gelfclient

Class GelfMessageBuilder

java.lang.Object

org.graylog2.gelfclient.GelfMessageBuilder

public class GelfMessageBuilder
extends Object

GelfMessageBuilder can be used to build one or more valid GelfMessages.

Since the message properties are stored in the GelfMessageBuilder instance, it can be used as a template for building GelfMessages.

This class is not thread-safe.

Author:

Bernd Ahlers

See Also:

GelfMessage

Constructor Summary

Constructors

Constructor and Description
GelfMessageBuilder(String message) Construct a GelfMessageBuilder instance with the given message.
GelfMessageBuilder(String message, String host) Construct a GelfMessageBuilder instance with the given message and @{code host} field.
GelfMessageBuilder(String message, String host, GelfMessageVersion version) Construct a GelfMessageBuilder instance with the given message and @{code host} field.

Method Summary

Modifier and Type	Method and Description
GelfMessageBuilder	additionalField(String key, Object value) Add an additional field (key-/value-pair) to the GelfMessage.
GelfMessageBuilder	additionalFields(Map<String,Object> additionalFields) Add the contents of a Map as additional fields (key-/value-pairs) to the GelfMessage.
GelfMessage	build() Build a new GelfMessage with all information from the GelfMessageBuilder.
GelfMessageBuilder	fullMessage(String fullMessage) Set the full message (e. g. containing a stack trace) of the GelfMessage.
GelfMessageBuilder	level(GelfMessageLevel level) Set the level (priority) of the GelfMessage.
GelfMessageBuilder	message(String message) Set the (short) message of the GelfMessage.
GelfMessageBuilder	timestamp(double timestamp) Set the timestamp (seconds since UNIX epoch) of the GelfMessage.
GelfMessageBuilder	timestamp(long millis) Set the timestamp (milliseconds since UNIX epoch) of the GelfMessage.

Methods inherited from class java.lang.Object

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

Constructor Detail

GelfMessageBuilder

public GelfMessageBuilder(String message)

Construct a GelfMessageBuilder instance with the given message.

Parameters:

message - The message of the GelfMessage

GelfMessageBuilder

public GelfMessageBuilder(String message,
                          String host)

Construct a GelfMessageBuilder instance with the given message and @{code host} field.

Parameters:

message - The message of the GelfMessage

host - The contents of the host field of the GelfMessage

GelfMessageBuilder

public GelfMessageBuilder(String message,
                          String host,
                          GelfMessageVersion version)

Construct a GelfMessageBuilder instance with the given message and @{code host} field.

Parameters:

message - The message of the GelfMessage

host - The contents of the host field of the GelfMessage

version - The version of the GELF specification to use

Method Detail

message

public GelfMessageBuilder message(String message)

Set the (short) message of the GelfMessage.

Parameters:

message - the (short) message of the GelfMessage

Returns:

this instance

fullMessage

public GelfMessageBuilder fullMessage(String fullMessage)

Set the full message (e. g. containing a stack trace) of the GelfMessage.

Parameters:

fullMessage - the full message of the GelfMessage

Returns:

this instance

timestamp

public GelfMessageBuilder timestamp(double timestamp)

Set the timestamp (seconds since UNIX epoch) of the GelfMessage.

Parameters:

timestamp - the timestamp of the GelfMessage (seconds since UNIX epoch)

Returns:

this instance

timestamp

public GelfMessageBuilder timestamp(long millis)

Set the timestamp (milliseconds since UNIX epoch) of the GelfMessage.

Parameters:

millis - the timestamp of the GelfMessage (milliseconds since UNIX epoch)

Returns:

this instance

level

public GelfMessageBuilder level(GelfMessageLevel level)

Set the level (priority) of the GelfMessage. Can be set to null to remove the (optional) level from the GelfMessage.

Parameters:

level - the GelfMessageLevel of the GelfMessage.

Returns:

this instance

additionalField

public GelfMessageBuilder additionalField(String key,
                                          Object value)

Add an additional field (key-/value-pair) to the GelfMessage.

Parameters:

key - the key of the additional field

value - the value of the additional field

Returns:

this instance

additionalFields

public GelfMessageBuilder additionalFields(Map<String,Object> additionalFields)

Add the contents of a Map as additional fields (key-/value-pairs) to the GelfMessage.

Parameters:

additionalFields - the Map which will be added as additional fields

Returns:

this instance

build

public GelfMessage build()

Build a new GelfMessage with all information from the GelfMessageBuilder.

Returns:

a new GelfMessage instance.

Throws:

IllegalArgumentException - if any mandatory information is missing.