com.snowplowanalytics.snowplow.tracker.configuration

Class SubjectConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.tracker.configuration.SubjectConfiguration

public class SubjectConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SubjectConfiguration() Create a Subject instance.

Method Summary

Modifier and Type	Method and Description
SubjectConfiguration	colorDepth(int depth)
SubjectConfiguration	domainSessionId(java.lang.String domainSessionId)
SubjectConfiguration	domainUserId(java.lang.String domainUserId)
int	getColorDepth() Returns the color depth.
java.lang.String	getDomainSessionId() Returns the domain session ID (UUID string).
java.lang.String	getDomainUserId() Returns the domain user ID (UUID string).
java.lang.String	getIpAddress() Returns the IP address.
java.lang.String	getLanguage() Returns the device language.
java.lang.String	getNetworkUserId() Returns the network user ID (UUID string).
int	getScreenResHeight() Returns the screen resolution height, in pixels.
int	getScreenResWidth() Returns the screen resolution width, in pixels.
java.lang.String	getTimezone() Returns the timezone.
java.lang.String	getUseragent() Returns the useragent.
java.lang.String	getUserId() Returns the user ID.
int	getViewPortHeight() Returns the viewport height, in pixels.
int	getViewPortWidth() Returns the viewport width, in pixels.
SubjectConfiguration	ipAddress(java.lang.String ipAddress)
SubjectConfiguration	language(java.lang.String language)
SubjectConfiguration	networkUserId(java.lang.String networkUserId) This overrides the network user ID set by the Collector in response Cookies.
SubjectConfiguration	screenResolution(int width, int height) Set the screen resolution.
SubjectConfiguration	timezone(java.lang.String timezone) Note that timezone is set by default to the server's timezone (`TimeZone tz = Calendar.getInstance().getTimeZone().getID()`)
SubjectConfiguration	useragent(java.lang.String useragent)
SubjectConfiguration	userId(java.lang.String userId) Set a unique user ID.
SubjectConfiguration	viewPort(int width, int height) Set the viewport size.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectConfiguration

public SubjectConfiguration()

Create a Subject instance. By default, timezone is set to the server's timezone.

Method Detail

getUserId

public java.lang.String getUserId()

Returns the user ID.

Returns:

user ID

getScreenResWidth

public int getScreenResWidth()

Returns the screen resolution width, in pixels.

Returns:

screen width

getScreenResHeight

public int getScreenResHeight()

Returns the screen resolution height, in pixels.

Returns:

screen height

getViewPortWidth

public int getViewPortWidth()

Returns the viewport width, in pixels.

Returns:

viewport width

getViewPortHeight

public int getViewPortHeight()

Returns the viewport height, in pixels.

Returns:

viewport height

getColorDepth

public int getColorDepth()

Returns the color depth.

Returns:

color depth

getTimezone

public java.lang.String getTimezone()

Returns the timezone. Automatically set by default to that of the server.

Returns:

timezone

getLanguage

public java.lang.String getLanguage()

Returns the device language.

Returns:

language

getIpAddress

public java.lang.String getIpAddress()

Returns the IP address.

Returns:

IP address

getUseragent

public java.lang.String getUseragent()

Returns the useragent.

Returns:

useragent

getNetworkUserId

public java.lang.String getNetworkUserId()

Returns the network user ID (UUID string).

Returns:

network user ID

getDomainUserId

public java.lang.String getDomainUserId()

Returns the domain user ID (UUID string).

Returns:

domain user ID

getDomainSessionId

public java.lang.String getDomainSessionId()

Returns the domain session ID (UUID string).

Returns:

domain session ID

userId

public SubjectConfiguration userId(java.lang.String userId)

Set a unique user ID.

Parameters:

userId - a user ID

Returns:

itself

screenResolution

public SubjectConfiguration screenResolution(int width,
                                             int height)

Set the screen resolution.

Parameters:

width - width in pixels

height - height in pixels

Returns:

itself

viewPort

public SubjectConfiguration viewPort(int width,
                                     int height)

Set the viewport size.

Parameters:

width - width in pixels

height - height in pixels

Returns:

itself

colorDepth

public SubjectConfiguration colorDepth(int depth)

Parameters:

depth - a color depth integer

Returns:

itself

timezone

public SubjectConfiguration timezone(java.lang.String timezone)

Note that timezone is set by default to the server's timezone (`TimeZone tz = Calendar.getInstance().getTimeZone().getID()`)

Parameters:

timezone - a timezone string

Returns:

itself

language

public SubjectConfiguration language(java.lang.String language)

Parameters:

language - a language string

Returns:

itself

ipAddress

public SubjectConfiguration ipAddress(java.lang.String ipAddress)

Parameters:

ipAddress - a ipAddress string

Returns:

itself

useragent

public SubjectConfiguration useragent(java.lang.String useragent)

Parameters:

useragent - a useragent string

Returns:

itself

networkUserId

public SubjectConfiguration networkUserId(java.lang.String networkUserId)

This overrides the network user ID set by the Collector in response Cookies.

Parameters:

networkUserId - a networkUserId string

Returns:

itself

domainUserId

public SubjectConfiguration domainUserId(java.lang.String domainUserId)

Parameters:

domainUserId - a domainUserId string

Returns:

itself

domainSessionId

public SubjectConfiguration domainSessionId(java.lang.String domainSessionId)

Parameters:

domainSessionId - a domainSessionId string

Returns:

itself