com.snowplowanalytics.snowplow.tracker

Class Tracker

java.lang.Object

com.snowplowanalytics.snowplow.tracker.Tracker

public class Tracker
extends java.lang.Object

Allows tracking of Events.

Constructor Summary

Constructors

Constructor and Description
Tracker(TrackerConfiguration trackerConfig, Emitter emitter) Creates a new Snowplow Tracker.
Tracker(TrackerConfiguration trackerConfig, Emitter emitter, Subject subject) Creates a new Snowplow Tracker.

Method Summary

Modifier and Type	Method and Description
void	close() Attempts to send all remaining events, then shuts down the Emitter so that no more events can be sent.
java.lang.String	getAppId()
boolean	getBase64Encoded()
Emitter	getEmitter()
java.lang.String	getNamespace()
TrackerParameters	getParameters()
DevicePlatform	getPlatform()
Subject	getSubject()
java.lang.String	getTrackerVersion() The Java tracker release version, e.g.
void	setEmitter(Emitter emitter) Change the Emitter used to send events.
void	setSubject(Subject subject) Sets a new Subject object which will get attached to each event payload.
java.util.List<java.lang.String>	track(Event event) Handles tracking the different types of events.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tracker

public Tracker(TrackerConfiguration trackerConfig,
               Emitter emitter,
               Subject subject)

Creates a new Snowplow Tracker.

Parameters:

trackerConfig - a TrackerConfiguration object

emitter - an Emitter

subject - a Subject

Tracker

public Tracker(TrackerConfiguration trackerConfig,
               Emitter emitter)

Creates a new Snowplow Tracker.

Parameters:

trackerConfig - a TrackerConfiguration object

emitter - an Emitter

Method Detail

setEmitter

public void setEmitter(Emitter emitter)

Change the Emitter used to send events.

Parameters:

emitter - a new emitter

setSubject

public void setSubject(Subject subject)

Sets a new Subject object which will get attached to each event payload.

Parameters:

subject - the new Subject

getEmitter

public Emitter getEmitter()

Returns:

the emitter associated with the tracker

getSubject

public Subject getSubject()

Returns:

the Tracker-associated Subject

getTrackerVersion

public java.lang.String getTrackerVersion()

The Java tracker release version, e.g. 0.12.0.

Returns:

the tracker version

getNamespace

public java.lang.String getNamespace()

Returns:

the trackers namespace

getAppId

public java.lang.String getAppId()

Returns:

the tracker Application ID

getBase64Encoded

public boolean getBase64Encoded()

Returns:

the base64 setting of the tracker

getPlatform

public DevicePlatform getPlatform()

Returns:

the Tracker platform, e.g. "srv"

getParameters

public TrackerParameters getParameters()

Returns:

the wrapper containing the Tracker parameters

track

public java.util.List<java.lang.String> track(Event event)

Handles tracking the different types of events. A TrackerPayload object - or more than one, in the case of eCommerceTransaction events - will be created from the Event. This is passed to the configured Emitter. If the event was successfully added to the Emitter buffer for sending, a list containing the payload's eventId string (a UUID) is returned. EcommerceTransactions will return all the relevant eventIds in the list. If the Emitter event buffer is full, the payload will be lost. In this case, this method returns a list containing null.

Implementation note: As a side effect of adding a payload to the Emitter, it triggers an Emitter thread to emit a batch of events.

Parameters:

event - the event to track

Returns:

a list of eventIDs (UUIDs)

close

public void close()

Attempts to send all remaining events, then shuts down the Emitter so that no more events can be sent. This method calls the Emitter.close() method. For the default BatchEmitter, this stops the ScheduledExecutorService and the thread pool (non-daemon threads). There is no way to restart the Emitter after calling close().