com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.session.client

Class DefaultSessionClient

java.lang.Object

com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.session.client.DefaultSessionClient

All Implemented Interfaces:

InternalSessionClient, SessionClient

public class DefaultSessionClient
extends java.lang.Object
implements InternalSessionClient

The Default Session Client Works with Amazon Mobile Analytics and the Event Client to manage mobile application sessions. Will relay events to the Delivery Client, which will eventually send them to ERS, that will be interpreted by TailWind as data necessary to generate reports on Daily Active Users and Average Session Length. Additionally, when a session is "active", a global attribute will be added to custom events traveling through the Event Client that will associate these custom events with the active session so that relationships can be interpreted. Session Events fired: - Session Start - Beginning of the application session - Session Stop - End of the application session - Session Pause - A brief pause in the application session - Session Resume - Reactivates the application session after a pause Follows a State Design pattern, wherein the actual implementation of the methods start(), stop(), pause(), and resume() will be carried out by nested classes, to accommodate for behavior changes of the client in response to changes of the application session's state.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AnalyticsContext	context
protected static long	DEFAULT_RESTART_DELAY
protected static long	DEFAULT_RESUME_DELAY
protected InternalEventClient	eventClient
protected static Logger	logger
protected static java.lang.String	RESTART_DELAY_CONFIG_KEY
protected static java.lang.String	RESUME_DELAY_CONFIG_KEY
protected Session	session
static java.lang.String	SESSION_DURATION_METRIC_KEY
static java.lang.String	SESSION_ID_ATTRIBUTE_KEY
static java.lang.String	SESSION_PAUSE_EVENT_TYPE
static java.lang.String	SESSION_RESUME_EVENT_TYPE
static java.lang.String	SESSION_START_EVENT_TYPE
static java.lang.String	SESSION_START_TIME_ATTRIBUTE_KEY
static java.lang.String	SESSION_STOP_EVENT_TYPE
static java.lang.String	SESSION_STOP_TIME_ATTRIBUTE_KEY
protected SessionStore	sessionStore
protected SessionClientState	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSessionClient(AnalyticsContext context, InternalEventClient eventClient, SessionStore sessionStore) CONSTRUCTOR

Method Summary

Methods

Modifier and Type	Method and Description
protected void	changeState(DefaultSessionClient.SessionState s)
long	getRestartDelay()
long	getResumeDelay()
protected Session	getSession() Getters
protected DefaultSessionClient.SessionState	getSessionState() Returns the Application Session's state
static DefaultSessionClient	newInstance(AnalyticsContext context, InternalEventClient eventClient) STATIC FACTORY
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
java.lang.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 java.lang.String SESSION_START_EVENT_TYPE

See Also:

Constant Field Values

SESSION_STOP_EVENT_TYPE

public static final java.lang.String SESSION_STOP_EVENT_TYPE

See Also:

Constant Field Values

SESSION_PAUSE_EVENT_TYPE

public static final java.lang.String SESSION_PAUSE_EVENT_TYPE

See Also:

Constant Field Values

SESSION_RESUME_EVENT_TYPE

public static final java.lang.String SESSION_RESUME_EVENT_TYPE

See Also:

Constant Field Values

SESSION_ID_ATTRIBUTE_KEY

public static final java.lang.String SESSION_ID_ATTRIBUTE_KEY

See Also:

Constant Field Values

SESSION_DURATION_METRIC_KEY

public static final java.lang.String SESSION_DURATION_METRIC_KEY

See Also:

Constant Field Values

SESSION_START_TIME_ATTRIBUTE_KEY

public static final java.lang.String SESSION_START_TIME_ATTRIBUTE_KEY

See Also:

Constant Field Values

SESSION_STOP_TIME_ATTRIBUTE_KEY

public static final java.lang.String SESSION_STOP_TIME_ATTRIBUTE_KEY

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

See Also:

Constant Field Values

RESTART_DELAY_CONFIG_KEY

protected static final java.lang.String RESTART_DELAY_CONFIG_KEY

See Also:

Constant Field Values

logger

protected static final Logger logger

eventClient

protected final InternalEventClient eventClient

context

protected final AnalyticsContext context

session

protected Session session

state

protected SessionClientState state

sessionStore

protected final SessionStore sessionStore

Constructor Detail

DefaultSessionClient

protected DefaultSessionClient(AnalyticsContext context,
                    InternalEventClient eventClient,
                    SessionStore sessionStore)

CONSTRUCTOR

Parameters:

context -

eventClient -

Method Detail

newInstance

public static DefaultSessionClient newInstance(AnalyticsContext context,
                               InternalEventClient eventClient)

STATIC FACTORY

Parameters:

context -

eventClient -

Returns:

new DefaultSessionClient object

startSession

public void startSession()

Starts an application session Used solely by Amazon Insights

Specified by:

startSession in interface InternalSessionClient

stopSession

public void stopSession()

Stops an application session Used solely by Amazon Insights

Specified by:

stopSession in interface InternalSessionClient

pauseSession

public void pauseSession()

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

Specified by:

pauseSession in interface SessionClient

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.

Specified by:

resumeSession in interface SessionClient

toString

public java.lang.String toString()

Overridden toString method for testing

Overrides:

toString in class java.lang.Object

Returns:

diagnostic string

getSession

protected Session getSession()

Getters

getRestartDelay

public long getRestartDelay()

getResumeDelay

public long getResumeDelay()

getSessionState

protected DefaultSessionClient.SessionState getSessionState()

Returns the Application Session's state

changeState

protected void changeState(DefaultSessionClient.SessionState s)