com.snowplowanalytics.snowplow.tracker

Class Snowplow

java.lang.Object

com.snowplowanalytics.snowplow.tracker.Snowplow

public class Snowplow
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Snowplow()

Method Summary

Modifier and Type	Method and Description
static Tracker	createTracker(java.lang.String namespace, java.lang.String appId, java.lang.String collectorUrl) Create a Snowplow tracker with default configuration by providing three parameters.
static Tracker	createTracker(TrackerConfiguration trackerConfig, NetworkConfiguration networkConfig) Create a Snowplow tracker using Configuration objects.
static Tracker	createTracker(TrackerConfiguration trackerConfig, NetworkConfiguration networkConfig, EmitterConfiguration emitterConfig) Create a Snowplow tracker using Configuration objects.
static Tracker	createTracker(TrackerConfiguration trackerConfig, NetworkConfiguration networkConfig, EmitterConfiguration emitterConfig, SubjectConfiguration subjectConfig) Create a Snowplow tracker using Configuration objects.
static Tracker	createTracker(TrackerConfiguration trackerConfig, NetworkConfiguration networkConfig, SubjectConfiguration subjectConfig) Create a Snowplow tracker using Configuration objects.
static Tracker	getDefaultTracker()
static java.util.Set<java.lang.String>	getInstancedTrackerNamespaces()
static Tracker	getTracker(java.lang.String namespace) Get a Tracker by its namespace
static void	registerTracker(Tracker tracker) Register a Tracker instance that was created manually, not via the Snowplow.createTracker() method.
static boolean	removeTracker(java.lang.String namespace) Unregister a Tracker, using its namespace.
static boolean	removeTracker(Tracker tracker) Unregister a Tracker.
static void	reset() Clear (unregister) all trackers.
static boolean	setDefaultTracker(java.lang.String namespace) Set a registered Tracker as the default tracker, using its namespace.
static void	setDefaultTracker(Tracker tracker) Set a specific Tracker instance as the default tracker.

Methods inherited from class java.lang.Object

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

Constructor Detail

Snowplow

public Snowplow()

Method Detail

getInstancedTrackerNamespaces

public static java.util.Set<java.lang.String> getInstancedTrackerNamespaces()

Returns:

the stored tracker namespaces

getDefaultTracker

public static Tracker getDefaultTracker()

Returns:

the default Tracker, or null if no default is set

setDefaultTracker

public static void setDefaultTracker(Tracker tracker)

Set a specific Tracker instance as the default tracker. The Tracker will be added to the Snowplow class if its namespace is not already stored. The first Tracker created using createTracker() or registered with registerTracker() will automatically be the default tracker; this method is intended for use with multiple trackers.

Parameters:

tracker - the tracker to use as default

setDefaultTracker

public static boolean setDefaultTracker(java.lang.String namespace)

Set a registered Tracker as the default tracker, using its namespace.

Parameters:

namespace - the namespace of the tracker to set as default

Returns:

true if the tracker was found and set

createTracker

public static Tracker createTracker(TrackerConfiguration trackerConfig,
                                    NetworkConfiguration networkConfig,
                                    EmitterConfiguration emitterConfig,
                                    SubjectConfiguration subjectConfig)

Create a Snowplow tracker using Configuration objects.

Parameters:

trackerConfig - a TrackerConfiguration

networkConfig - a NetworkConfiguration (will be used to create an OkHttpClientAdapter)

emitterConfig - an EmitterConfiguration (will be used to create a BatchEmitter)

subjectConfig - a SubjectConfiguration

Returns:

the created Tracker

createTracker

public static Tracker createTracker(java.lang.String namespace,
                                    java.lang.String appId,
                                    java.lang.String collectorUrl)

Create a Snowplow tracker with default configuration by providing three parameters.

Parameters:

namespace - unique identifier for the Tracker instance

appId - application ID

collectorUrl - collector endpoint

Returns:

the created Tracker

createTracker

public static Tracker createTracker(TrackerConfiguration trackerConfig,
                                    NetworkConfiguration networkConfig,
                                    EmitterConfiguration emitterConfig)

Create a Snowplow tracker using Configuration objects.

Parameters:

trackerConfig - a TrackerConfiguration

networkConfig - a NetworkConfiguration

emitterConfig - an EmitterConfiguration

Returns:

the created Tracker

createTracker

public static Tracker createTracker(TrackerConfiguration trackerConfig,
                                    NetworkConfiguration networkConfig)

Create a Snowplow tracker using Configuration objects.

Parameters:

trackerConfig - a TrackerConfiguration

networkConfig - a NetworkConfiguration

Returns:

the created Tracker

createTracker

public static Tracker createTracker(TrackerConfiguration trackerConfig,
                                    NetworkConfiguration networkConfig,
                                    SubjectConfiguration subjectConfig)

Create a Snowplow tracker using Configuration objects.

Parameters:

trackerConfig - a TrackerConfiguration

networkConfig - a NetworkConfiguration

subjectConfig - a SubjectConfiguration

Returns:

the created Tracker

registerTracker

public static void registerTracker(Tracker tracker)

Register a Tracker instance that was created manually, not via the Snowplow.createTracker() method.

Parameters:

tracker - a Tracker instance

getTracker

public static Tracker getTracker(java.lang.String namespace)

Get a Tracker by its namespace

Parameters:

namespace - the namespace of the tracker to retrieve

Returns:

the retrieved tracker

removeTracker

public static boolean removeTracker(java.lang.String namespace)

Unregister a Tracker, using its namespace.

Parameters:

namespace - the namespace of the tracker to remove

Returns:

true if the tracker was found and removed

removeTracker

public static boolean removeTracker(Tracker tracker)

Unregister a Tracker.

Parameters:

tracker - the tracker to remove

Returns:

true if the tracker was found and removed

reset

public static void reset()

Clear (unregister) all trackers.