com.snowplowanalytics.snowplow.tracker.configuration

Class TrackerConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.tracker.configuration.TrackerConfiguration

public class TrackerConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TrackerConfiguration(java.lang.String namespace, java.lang.String appId) Create a TrackerConfiguration instance.

Method Summary

Modifier and Type	Method and Description
TrackerConfiguration	base64Encoded(boolean base64Encoded) Whether JSONs in the payload should be base-64 encoded (default is true)
java.lang.String	getAppId() Returns the application ID.
java.lang.String	getNamespace() Returns the unique tracker namespace.
DevicePlatform	getPlatform() Returns the DevicePlatform for the tracker.
boolean	isBase64Encoded() Returns whether JSONs in the payload are base-64 encoded.
TrackerConfiguration	platform(DevicePlatform platform) The DevicePlatform the tracker is running on (default is "srv", ServerSideApp).

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackerConfiguration

public TrackerConfiguration(java.lang.String namespace,
                            java.lang.String appId)

Create a TrackerConfiguration instance. The namespace is the unique identifier for the instance. By default, the platform is ServerSideApp, and JSONs will be base64 encoded.

Parameters:

namespace - identifier for the Tracker instance

appId - application ID

Method Detail

getNamespace

public java.lang.String getNamespace()

Returns the unique tracker namespace.

Returns:

tracker namespace

getAppId

public java.lang.String getAppId()

Returns the application ID.

Returns:

application ID

getPlatform

public DevicePlatform getPlatform()

Returns the DevicePlatform for the tracker.

Returns:

what platform the app is running on

isBase64Encoded

public boolean isBase64Encoded()

Returns whether JSONs in the payload are base-64 encoded.

Returns:

true if encoded

platform

public TrackerConfiguration platform(DevicePlatform platform)

The DevicePlatform the tracker is running on (default is "srv", ServerSideApp).

Parameters:

platform - The device platform the tracker is running on

Returns:

itself

base64Encoded

public TrackerConfiguration base64Encoded(boolean base64Encoded)

Whether JSONs in the payload should be base-64 encoded (default is true)

Parameters:

base64Encoded - JSONs should be encoded or not

Returns:

itself