com.snowplowanalytics.snowplow.tracker.payload

Class TrackerPayload

java.lang.Object

com.snowplowanalytics.snowplow.tracker.payload.TrackerPayload

All Implemented Interfaces:

Payload

public class TrackerPayload
extends java.lang.Object
implements Payload

A TrackerPayload stores a map of key - pair values. When the Emitter attempts to send a TrackerPayload, these pairs are extracted and added to the HTTP request (via a SelfDescribingJson). The deviceSentTimestamp ("stm") is added at that point. EventId and deviceCreatedTimestamp are added to the internal map at TrackerPayload initialization.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	payload

Constructor Summary

Constructors

Constructor and Description
TrackerPayload()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, java.lang.String value) Add a key-value pair to the payload.
void	addMap(java.util.Map<java.lang.String,?> map, boolean base64Encoded, java.lang.String typeEncoded, java.lang.String typeNotEncoded) Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.
void	addMap(java.util.Map<java.lang.String,java.lang.String> map) Add all the mappings from the specified map.
long	getByteSize() Returns the byte size of a payload.
java.lang.Long	getDeviceCreatedTimestamp()
java.lang.String	getEventId()
java.util.Map<java.lang.String,java.lang.String>	getMap() Returns the Payload as a Map.
java.lang.String	toString() Returns the Payload as a string.

Methods inherited from class java.lang.Object

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

Field Detail

payload

protected final java.util.Map<java.lang.String,java.lang.String> payload

Constructor Detail

TrackerPayload

public TrackerPayload()

Method Detail

getEventId

public java.lang.String getEventId()

getDeviceCreatedTimestamp

public java.lang.Long getDeviceCreatedTimestamp()

add

public void add(java.lang.String key,
                java.lang.String value)

Add a key-value pair to the payload. Checks that neither the key nor the value are null or empty.

Specified by:

add in interface Payload

Parameters:

key - The parameter key

value - The parameter value as a String

addMap

public void addMap(java.util.Map<java.lang.String,java.lang.String> map)

Add all the mappings from the specified map. The effect is the equivalent to that of calling add(String, String) for each key value pair.

Specified by:

addMap in interface Payload

Parameters:

map - Key-Value pairs to be stored in this payload

addMap

public void addMap(java.util.Map<java.lang.String,?> map,
                   boolean base64Encoded,
                   java.lang.String typeEncoded,
                   java.lang.String typeNotEncoded)

Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.

Specified by:

addMap in interface Payload

Parameters:

map - Map to be converted to a String and stored as a value

base64Encoded - The option you choose to encode the data

typeEncoded - The key that would be set if the encoding option was set to true

typeNotEncoded - They key that would be set if the encoding option was set to false

getMap

public java.util.Map<java.lang.String,java.lang.String> getMap()

Returns the Payload as a Map.

Specified by:

getMap in interface Payload

Returns:

A Map of all the key-value entries

getByteSize

public long getByteSize()

Returns the byte size of a payload.

Specified by:

getByteSize in interface Payload

Returns:

A long representing the byte size of the payload.

toString

public java.lang.String toString()

Returns the Payload as a string. This is essentially the toString from the ObjectNode used to store the Payload.

Specified by:

toString in interface Payload

Overrides:

toString in class java.lang.Object

Returns:

A string value of the Payload.