com.snowplowanalytics.snowplow.tracker.payload

Interface Payload

All Known Implementing Classes:

SelfDescribingJson, TrackerPayload

public interface Payload

The Payload is used to store all the parameters and configurations that are used to send data via the HTTP GET/POST request.

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.util.Map<java.lang.String,?>	getMap() Returns the Payload as a HashMap.
java.lang.String	toString() Returns the Payload as a string.

Method Detail

add

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

Add a key-value pair to the payload. It checks that neither the key nor value is null or empty.

Parameters:

key - The parameter key

value - The parameter value as a String

addMap

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.

Parameters:

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

addMap

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.

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

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

Returns the Payload as a HashMap.

Returns:

A HashMap

getByteSize

long getByteSize()

Returns the byte size of a payload.

Returns:

A long representing the byte size of the payload.

toString

java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string value of the Payload.