com.amazonaws.mobileconnectors.pinpoint.analytics

Class SessionClient

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.SessionClient

public class SessionClient
extends Object

Client for managing starting and stopping sessions which records session events automatically as the session is stopped or started. It is recommended to start the session when the application comes to the foreground and stop the session when it goes to the background.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SessionClient.SessionState Internal Representation of Application Session's state

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NO_SESSION_ID This is the identifier set when there is no current session
protected com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext	pinpointContext The context object wraps all the essential information from the app that are required.
protected Session	session This session object tracks whether or not it has been paused by checking the status of it's stop time.
static String	SESSION_PAUSE_EVENT_TYPE The eventType recorded for session pause events
static String	SESSION_RESUME_EVENT_TYPE The eventType recorded for session resume events
static String	SESSION_START_EVENT_TYPE The eventType recorded for session start events
static String	SESSION_STOP_EVENT_TYPE The eventType recorded for session stop events
protected static String	SHARED_PREFS_SESSION_KEY The key name used in Shared Preferences

Constructor Summary

Constructors

Constructor and Description
SessionClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
protected void	executePause() Pause the current session object - Fire a Session Pause Event - Persist Session to the file system.
protected void	executeResume() Re-Activate the session - Fire Session Resume Event/ Record an event of type SESSION_RESUME_EVENT_TYPE
protected void	executeStart() Start a new Session.
protected void	executeStop() Stop the current Session.
protected Session	getSession() Getters
protected SessionClient.SessionState	getSessionState()
void	pauseSession() Briefly pauses an application session.
void	resumeSession() Resumes an application session.
void	startSession() Start a session which records a SESSION_START_EVENT_TYPE event and saves that sessionId to the AnalyticsClient to be used for recording future events.
void	stopSession() Stops a session which records a SESSION_STOP_EVENT_TYPE event and flushes the events in localstorage for submission.
String	toString() Overridden toString method for testing

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_START_EVENT_TYPE

public static final String SESSION_START_EVENT_TYPE

The eventType recorded for session start events

See Also:

Constant Field Values

SESSION_STOP_EVENT_TYPE

public static final String SESSION_STOP_EVENT_TYPE

The eventType recorded for session stop events

See Also:

Constant Field Values

SESSION_PAUSE_EVENT_TYPE

public static final String SESSION_PAUSE_EVENT_TYPE

The eventType recorded for session pause events

See Also:

Constant Field Values

SESSION_RESUME_EVENT_TYPE

public static final String SESSION_RESUME_EVENT_TYPE

The eventType recorded for session resume events

See Also:

Constant Field Values

NO_SESSION_ID

protected static final String NO_SESSION_ID

This is the identifier set when there is no current session

See Also:

Constant Field Values

SHARED_PREFS_SESSION_KEY

protected static final String SHARED_PREFS_SESSION_KEY

The key name used in Shared Preferences

See Also:

Constant Field Values

pinpointContext

protected final com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext

The context object wraps all the essential information from the app that are required.

session

protected Session session

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. This refers to the current session object.

Constructor Detail

SessionClient

public SessionClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)

CONSTRUCTOR

Parameters:

pinpointContext - The PinpointContext

Method Detail

startSession

public void startSession()

Start a session which records a SESSION_START_EVENT_TYPE event and saves that sessionId to the AnalyticsClient to be used for recording future events. This triggers an update of the endpointProfile. It is recommended to start the session when the application comes to the foreground.

stopSession

public void stopSession()

Stops a session which records a SESSION_STOP_EVENT_TYPE event and flushes the events in localstorage for submission. It is recommended to stop the session when the application goes to the background.

pauseSession

public void pauseSession()

Briefly pauses an application session. This records a SESSION_PAUSE_EVENT_TYPE event. It is recommended to call in an activity's onPause() method.

resumeSession

public void resumeSession()

Resumes an application session. This records a SESSION_RESUME_EVENT_TYPE event. It is recommended to call in an activity's onResume() method.

toString

public String toString()

Overridden toString method for testing

Overrides:

toString in class Object

Returns:

diagnostic string

executeStart

protected void executeStart()

Start a new Session. Set the Session ID and start time and record an event of type SESSION_START_EVENT_TYPE.

executeStop

protected void executeStop()

Stop the current Session. First, pause the session if it's not paused already. Record the stop time and record an event of type SESSION_STOP_EVENT_TYPE. Additionally, stopping a session clears the campaign attributes.

executePause

protected void executePause()

Pause the current session object - Fire a Session Pause Event - Persist Session to the file system. (prepares for quiet death). Record an event of type SESSION_PAUSE_EVENT_TYPE

executeResume

protected void executeResume()

Re-Activate the session - Fire Session Resume Event/ Record an event of type SESSION_RESUME_EVENT_TYPE

getSession

protected Session getSession()

Getters

Returns:

the current session object

getSessionState

protected SessionClient.SessionState getSessionState()

Returns:

the current Session's state