com.amazonaws.mobileconnectors.pinpoint.analytics

Class SessionClient

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.SessionClient

public class SessionClient
extends Object

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 long	DEFAULT_RESTART_DELAY
protected static long	DEFAULT_RESUME_DELAY
protected static String	NO_SESSION_ID
protected com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext	pinpointContext
protected static String	RESTART_DELAY_CONFIG_KEY
protected static String	RESUME_DELAY_CONFIG_KEY
protected Session	session
static String	SESSION_PAUSE_EVENT_TYPE
static String	SESSION_RESUME_EVENT_TYPE
static String	SESSION_START_EVENT_TYPE
static String	SESSION_STOP_EVENT_TYPE
protected static String	SHARED_PREFS_SESSION_KEY

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
protected void	executeStart()
protected void	executeStop()
long	getRestartDelay()
long	getResumeDelay()
protected Session	getSession() Getters
protected SessionClient.SessionState	getSessionState() Returns the Application Session's state
void	pauseSession() Briefly pauses an application session.
void	resumeSession() Resumes an application session if the session has been paused within a defined time interval.
void	startSession() Starts an application session Used solely by Amazon Insights
void	stopSession() Stops an application session Used solely by Amazon Insights
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

See Also:

Constant Field Values

SESSION_STOP_EVENT_TYPE

public static final String SESSION_STOP_EVENT_TYPE

See Also:

Constant Field Values

SESSION_PAUSE_EVENT_TYPE

public static final String SESSION_PAUSE_EVENT_TYPE

See Also:

Constant Field Values

SESSION_RESUME_EVENT_TYPE

public static final String SESSION_RESUME_EVENT_TYPE

See Also:

Constant Field Values

DEFAULT_RESUME_DELAY

protected static final long DEFAULT_RESUME_DELAY

See Also:

Constant Field Values

DEFAULT_RESTART_DELAY

protected static final long DEFAULT_RESTART_DELAY

See Also:

Constant Field Values

RESUME_DELAY_CONFIG_KEY

protected static final String RESUME_DELAY_CONFIG_KEY

See Also:

Constant Field Values

RESTART_DELAY_CONFIG_KEY

protected static final String RESTART_DELAY_CONFIG_KEY

See Also:

Constant Field Values

NO_SESSION_ID

protected static final String NO_SESSION_ID

See Also:

Constant Field Values

SHARED_PREFS_SESSION_KEY

protected static final String SHARED_PREFS_SESSION_KEY

See Also:

Constant Field Values

pinpointContext

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

session

protected Session session

Constructor Detail

SessionClient

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

CONSTRUCTOR

Parameters:

pinpointContext -

Method Detail

startSession

public void startSession()

Starts an application session Used solely by Amazon Insights

stopSession

public void stopSession()

Stops an application session Used solely by Amazon Insights

pauseSession

public void pauseSession()

Briefly pauses an application session. Should be called in an activity's onPause() method.

resumeSession

public void resumeSession()

Resumes an application session if the session has been paused within a defined time interval. Otherwise, stops the old session and starts a new one. Should be called 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()

executeStop

protected void executeStop()

executePause

protected void executePause()

- Pause the current session object - Fire a Session Pause Event - Persist Session to the file system. (prepares for quiet death)

executeResume

protected void executeResume()

- Re-Activate the session - Fire Session Resume Event

getSession

protected Session getSession()

Getters

getRestartDelay

public long getRestartDelay()

getResumeDelay

public long getResumeDelay()

getSessionState

protected SessionClient.SessionState getSessionState()

Returns the Application Session's state