com.snowplowanalytics.snowplow.tracker

Class Utils

java.lang.Object

com.snowplowanalytics.snowplow.tracker.Utils

public class Utils
extends java.lang.Object

Provides basic Utilities for the Snowplow Tracker.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	base64Encode(java.lang.String string, java.nio.charset.Charset charset) Encodes a string into Base64.
static java.lang.String	getEventId() Generates a random UUID for each event.
static java.lang.String	getTimestamp() Returns the current System time as a String.
static java.lang.String	getTimezone() Gets the default timezone of the server running the library.
static int	getTransactionId() Returns a Transaction ID integer.
static long	getUTF8Length(java.lang.String s) Count the number of bytes a string will occupy when UTF-8 encoded
static boolean	isValidUrl(java.lang.String url) Validates a uri and checks that it is valid before being used by the emitter.
static java.lang.String	mapToJSONString(java.util.Map<java.lang.String,?> map) Processes a Map into a JSON String or returns an empty String if it fails
static java.lang.String	mapToQueryString(java.util.Map<java.lang.String,?> map) Builds a QueryString from a Map of Name-Value pairs.
static java.lang.String	urlEncodeUTF8(java.lang.Object o) Encodes an Object in UTF-8.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

getTimestamp

public static java.lang.String getTimestamp()

Returns the current System time as a String.

Returns:

the system time as a string

getEventId

public static java.lang.String getEventId()

Generates a random UUID for each event.

Returns:

a UUID string

getTransactionId

public static int getTransactionId()

Returns a Transaction ID integer.

Returns:

a new random Transaction ID

isValidUrl

public static boolean isValidUrl(java.lang.String url)

Validates a uri and checks that it is valid before being used by the emitter.

Parameters:

url - the uri to validate

Returns:

whether the uri is valid or not

getTimezone

public static java.lang.String getTimezone()

Gets the default timezone of the server running the library.

Returns:

the timezone id string

base64Encode

public static java.lang.String base64Encode(java.lang.String string,
                                            java.nio.charset.Charset charset)

Encodes a string into Base64.

Parameters:

string - the string too encode

charset - the charset used when base64 encoding string

Returns:

a Base64 encoded string

mapToJSONString

public static java.lang.String mapToJSONString(java.util.Map<java.lang.String,?> map)

Processes a Map into a JSON String or returns an empty String if it fails

Parameters:

map - the map to process into a JSON String

Returns:

the final JSON String

mapToQueryString

public static java.lang.String mapToQueryString(java.util.Map<java.lang.String,?> map)

Builds a QueryString from a Map of Name-Value pairs.

Parameters:

map - The map to convert

Returns:

the QueryString ready for sending

urlEncodeUTF8

public static java.lang.String urlEncodeUTF8(java.lang.Object o)

Encodes an Object in UTF-8. Will attempt to cast the object to a String and then encode.

Parameters:

o - The object to encode

Returns:

either the encoded String or an empty String if it fails.

getUTF8Length

public static long getUTF8Length(java.lang.String s)

Count the number of bytes a string will occupy when UTF-8 encoded

Parameters:

s - the String to process

Returns:

number Length of s in bytes when UTF-8 encoded