Class BeaconEvent

java.lang.Object

com.suse.salt.netapi.event.BeaconEvent

public class BeaconEvent
extends Object

Represents an event fired by beacons

Field Summary

Fields

Modifier and Type	Field	Description
private final String	additional
private final String	beacon
private final com.google.gson.JsonElement	data
private static final com.google.gson.Gson	GSON
private final String	minionId
private static final Pattern	PATTERN

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BeaconEvent(String minionId, String beacon, String additional, com.google.gson.JsonElement data)	Creates a new BeaconEvent

Method Summary

Modifier and Type	Method	Description
String	getAdditional()	Provides additional information from the tag depending on the type of beacon
String	getBeacon()	Returns the beacon name.
Map<String,Object>	getData()	Return event data as Map
<R> R	getData(com.google.gson.reflect.TypeToken<R> type)	Return the event data parsed into the given type.
<R> R	getData(Class<R> type)	Return this event's data parsed into the given type.
String	getMinionId()	Returns the id of the minion that triggered the beacon
static Optional<BeaconEvent>	parse(Event event)	Utility method to parse e generic event to a more specific one

Methods inherited from class Object

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

Field Details

PATTERN

private static final Pattern PATTERN

GSON

private static final com.google.gson.Gson GSON

beacon

private final String beacon

minionId

private final String minionId

additional

private final String additional

data

private final com.google.gson.JsonElement data

Constructor Details

BeaconEvent

private BeaconEvent(String minionId,
 String beacon,
 String additional,
 com.google.gson.JsonElement data)

Creates a new BeaconEvent

Parameters:

minionId - the id of the minion sending the event

beacon - the beacon name

additional - additional information depending on the beacon

data - data containing more information about this event

Method Details

getBeacon

public String getBeacon()

Returns the beacon name.

Returns:

the beacon name

getMinionId

public String getMinionId()

Returns the id of the minion that triggered the beacon

Returns:

the minion id

getAdditional

public String getAdditional()

Provides additional information from the tag depending on the type of beacon

Returns:

additional information

getData

public <R> R getData(com.google.gson.reflect.TypeToken<R> type)

Return the event data parsed into the given type.

Type Parameters:

R - type to parse the data into

Parameters:

type - type token to parse data

Returns:

the event data

getData

public <R> R getData(Class<R> type)

Return this event's data parsed into the given type.

Type Parameters:

R - type to parse the data into

Parameters:

type - class to parse data

Returns:

the data

getData

public Map<String,Object> getData()

Return event data as Map

Returns:

event data as map

parse

public static Optional<BeaconEvent> parse(Event event)

Utility method to parse e generic event to a more specific one

Parameters:

event - the generic event to parse

Returns:

an option containing the parsed value or non if it could not be parsed