com.amazonaws.mobileconnectors.pinpoint.analytics

Class Session

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.Session

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

public class Session
extends Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

A Session Object Mostly immutable, with the exception of its stop time. This session object tracks whether or not it has been paused by checking the status of it's stop time. A session's stop time is only set when the session has been paused, and is set to -1 if it is currently running. Can be serialized and restored for persistence.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SESSION_ID_APPKEY_LENGTH
protected static String	SESSION_ID_DATE_FORMAT
protected static char	SESSION_ID_DELIMITER
protected static char	SESSION_ID_PAD_CHAR
protected static String	SESSION_ID_TIME_FORMAT
protected static int	SESSION_ID_UNIQID_LENGTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Session(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context) CONSTRUCTOR - ACTUAL Used by SessionClient
protected	Session(String sessionID, String startTime, String stopTime) Used by deserealizer

Method Summary

Modifier and Type	Method and Description
String	generateSessionID(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context) Generates Session ID by concatenating present AppKey, UniqueID, and --yyyyMMdd-HHmmssSSS
Long	getSessionDuration() Calculates and returns the session's duration Returns a duration of 0 if session is not paused or the system clock has been tampered with.
static Session	getSessionFromSerializedSession(String serializedSession) Re-Generates a session object that has been serialized Returns null if the input is null
String	getSessionID()
long	getStartTime()
Long	getStopTime()
boolean	isPaused() Session is considered paused if stopTime is not null
static Session	newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context) STATIC FACTORY
void	pause() Pauses the session object.
void	resume() Resumes the session object.
org.json.JSONObject	toJSONObject()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_ID_DATE_FORMAT

protected static final String SESSION_ID_DATE_FORMAT

See Also:

Constant Field Values

SESSION_ID_TIME_FORMAT

protected static final String SESSION_ID_TIME_FORMAT

See Also:

Constant Field Values

SESSION_ID_DELIMITER

protected static final char SESSION_ID_DELIMITER

See Also:

Constant Field Values

SESSION_ID_PAD_CHAR

protected static final char SESSION_ID_PAD_CHAR

See Also:

Constant Field Values

SESSION_ID_APPKEY_LENGTH

protected static final int SESSION_ID_APPKEY_LENGTH

See Also:

Constant Field Values

SESSION_ID_UNIQID_LENGTH

protected static final int SESSION_ID_UNIQID_LENGTH

See Also:

Constant Field Values

Constructor Detail

Session

protected Session(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)

CONSTRUCTOR - ACTUAL Used by SessionClient

Parameters:

context -

Session

protected Session(String sessionID,
                  String startTime,
                  String stopTime)

Used by deserealizer

Parameters:

sessionID -

startTime -

stopTime -

Method Detail

newInstance

public static Session newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)

STATIC FACTORY

Parameters:

context - The PinpointContext

Returns:

new Session object

getSessionFromSerializedSession

public static Session getSessionFromSerializedSession(String serializedSession)

Re-Generates a session object that has been serialized Returns null if the input is null

Parameters:

serializedSession - - a Session's serialization string.

Returns:

a session object identical to the one that was serialized

isPaused

public boolean isPaused()

Session is considered paused if stopTime is not null

Returns:

true iff session is currently paused

pause

public void pause()

Pauses the session object. Generates a stop time.

resume

public void resume()

Resumes the session object. Invalidates the stop time.

getSessionDuration

public Long getSessionDuration()

Calculates and returns the session's duration Returns a duration of 0 if session is not paused or the system clock has been tampered with.

Returns:

session duration in milliseconds

generateSessionID

public String generateSessionID(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)

Generates Session ID by concatenating present AppKey, UniqueID, and --yyyyMMdd-HHmmssSSS

Parameters:

context - The PinpointContext

Returns:

[String] SessionID

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

toString

public String toString()

Overrides:

toString in class Object

getSessionID

public String getSessionID()

getStartTime

public long getStartTime()

getStopTime

public Long getStopTime()