org.hawkular.agent.monitor.storage

Class AvailDataPayloadBuilderImpl

java.lang.Object

org.hawkular.agent.monitor.storage.AvailDataPayloadBuilderImpl

All Implemented Interfaces:

AvailDataPayloadBuilder

public class AvailDataPayloadBuilderImpl
extends Object
implements AvailDataPayloadBuilder

Allows one to build up a payload request to send to availability storage by adding data points one by one. After all data points are added, you can get the payload in either an object format or a JSON format.

Constructor Summary

Constructors

Constructor and Description
AvailDataPayloadBuilderImpl()

Method Summary

Modifier and Type	Method and Description
void	addDataPoint(String key, long timestamp, Avail value) Add an availability data point.
int	getNumberDataPoints()
String	getTenantId()
void	setTenantId(String tenantId) If the availability data is to be stored with a special tenant ID, this sets that tenant ID.
List<Map<String,Object>>	toObjectPayload()
String	toPayload()

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailDataPayloadBuilderImpl

public AvailDataPayloadBuilderImpl()

Method Detail

addDataPoint

public void addDataPoint(String key,
                         long timestamp,
                         Avail value)

Description copied from interface: AvailDataPayloadBuilder

Add an availability data point. When all availability data points are added, call AvailDataPayloadBuilder.toPayload() to get the payload message that can be used to send to the storage backend via the storage adapter.

Specified by:

addDataPoint in interface AvailDataPayloadBuilder

Parameters:

key - identifies the availability data point

timestamp - the time the availability was checked

value - the value of the availability

toObjectPayload

public List<Map<String,Object>> toObjectPayload()

toPayload

public String toPayload()

Specified by:

toPayload in interface AvailDataPayloadBuilder

Returns:

the payload in a format suitable for the storage adapter.

getNumberDataPoints

public int getNumberDataPoints()

Specified by:

getNumberDataPoints in interface AvailDataPayloadBuilder

Returns:

the number of data points that were added to the payload

setTenantId

public void setTenantId(String tenantId)

Description copied from interface: AvailDataPayloadBuilder

If the availability data is to be stored with a special tenant ID, this sets that tenant ID. If null is passed in, or if this method is not called, the agent's tenant ID is used.

Specified by:

setTenantId in interface AvailDataPayloadBuilder

Parameters:

tenantId - the tenant ID to associate the avail data with. May be null.

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface AvailDataPayloadBuilder

Returns:

the tenant ID to be associated with the avail data. If null, the agent's tenant ID is used.