com.mozilla.secops.parser

Class Event

java.lang.Object

com.mozilla.secops.parser.Event

All Implemented Interfaces:

Serializable

public class Event
extends Object
implements Serializable

Represents a high level event after being processed by a Parser.

After being parsed, all events are guaranteed to have an associated Payload value which contains information related to a specific type of event.

Specific parser implementations may also add Normalized data fields to the event.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Event	fromJSON(String input) Convert a JSON string into an Event
UUID	getEventId() Get unique event ID.
Mozlog	getMozlog() Get mozlog value
Normalized	getNormalized() Return normalized data set.
<T extends PayloadBase> T	getPayload() Get event payload.
Payload.PayloadType	getPayloadType() Return the type of payload data associated with this event.
String	getStackdriverLabel(String key) Get specific Stackdriver label value
Map<String,String>	getStackdriverLabels() Get Stackdriver labels
String	getStackdriverProject() Get Stackdriver project name
org.joda.time.DateTime	getTimestamp() Get event timestamp.
int	hashCode()
static String	iterableToJson(Iterable<Event> input) Utility function to convert an iterable list of events into a JSON string
static Iterable<Event>	jsonToIterable(String input) Utility function to convert a JSON string into an iterable list of events
void	setMozlog(Mozlog mozlog) Set mozlog value
<T extends PayloadBase> void	setPayload(T p) Set event payload.
void	setStackdriverLabels(Map<String,String> labels) Set Stackdriver labels
void	setStackdriverProject(String project) Set Stackdriver project name
void	setTimestamp(org.joda.time.DateTime t) Set event timestamp.
String	toJSON() Convert event into JSON string representation

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setPayload

public <T extends PayloadBase> void setPayload(T p)

Set event payload.

Type Parameters:

T - T

Parameters:

p - Payload data.

getPayload

public <T extends PayloadBase> T getPayload()

Get event payload.

Type Parameters:

T - T

Returns:

Payload data extending PayloadBase.

getPayloadType

public Payload.PayloadType getPayloadType()

Return the type of payload data associated with this event.

Returns:

Payload.PayloadType

getEventId

public UUID getEventId()

Get unique event ID.

Returns:

UUID associated with event.

getMozlog

public Mozlog getMozlog()

Get mozlog value

Returns:

Mozlog value or null if not available

setMozlog

public void setMozlog(Mozlog mozlog)

Set mozlog value

If the mozlog entry has a timestamp value, this timestamp will be used for the event timestamp.

Parameters:

mozlog - Mozlog values for event

setStackdriverProject

public void setStackdriverProject(String project)

Set Stackdriver project name

Parameters:

project - Project string

getStackdriverProject

public String getStackdriverProject()

Get Stackdriver project name

Returns:

Stackdriver project name, or null if was not present

setStackdriverLabels

public void setStackdriverLabels(Map<String,String> labels)

Set Stackdriver labels

Parameters:

labels - Labels

getStackdriverLabels

public Map<String,String> getStackdriverLabels()

Get Stackdriver labels

Returns:

Labels, null if not present

getStackdriverLabel

public String getStackdriverLabel(String key)

Get specific Stackdriver label value

Parameters:

key - Label key to return value for

Returns:

Value if present, null if not found

getTimestamp

public org.joda.time.DateTime getTimestamp()

Get event timestamp.

Returns:

Timestamp associated with event.

setTimestamp

public void setTimestamp(org.joda.time.DateTime t)

Set event timestamp.

Parameters:

t - DateTime to associate with event.

getNormalized

public Normalized getNormalized()

Return normalized data set.

Returns:

Normalized data associated with event.

toJSON

public String toJSON()

Convert event into JSON string representation

Returns:

JSON string, null on failure

fromJSON

public static Event fromJSON(String input)

Convert a JSON string into an Event

Parameters:

input - Input JSON string

Returns:

Event object or null on failure

jsonToIterable

public static Iterable<Event> jsonToIterable(String input)

Utility function to convert a JSON string into an iterable list of events

Parameters:

input - Input JSON string

Returns:

Iterable list of events, or null on failure

iterableToJson

public static String iterableToJson(Iterable<Event> input)

Utility function to convert an iterable list of events into a JSON string

Parameters:

input - List of events for conversion

Returns:

JSON string, null on failure