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 java.lang.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.

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateSessionID(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context) Generates Session ID by concatenating present AppKey, UniqueID, and --yyyyMMdd-HHmmssSSS
java.lang.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(java.lang.String serializedSession) Re-Generates a session object that has been serialized Returns null if the input is null
java.lang.String	getSessionID()
long	getStartTime()
java.lang.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()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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(java.lang.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 java.lang.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 java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSessionID

public java.lang.String getSessionID()

getStartTime

public long getStartTime()

getStopTime

public java.lang.Long getStopTime()