ly.count.sdk.java.internal

Class SessionImpl

java.lang.Object

ly.count.sdk.java.internal.SessionImpl

All Implemented Interfaces:

Byteable, ly.count.sdk.java.internal.EventImpl.EventRecorder, Storable, Session, Usage

public class SessionImpl
extends java.lang.Object
implements Session, Storable, ly.count.sdk.java.internal.EventImpl.EventRecorder

This class represents session concept, that is one indivisible usage occasion of your application. Any data sent to Countly server is processed in a context of Session. Only one session can send requests at a time, so even if you create 2 parallel sessions, they will be made consequent automatically at the time of Countly SDK choice with no correctness guarantees, so please avoid having parallel sessions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	began System.nanoTime() of begin(), update() and end() calls respectively.
protected CtxCore	ctx
protected View	currentView Current view event, that is started, but not ended yet
protected java.lang.Long	ended System.nanoTime() of begin(), update() and end() calls respectively.
protected java.util.List<Event>	events List of events still not added to request
protected java.lang.Long	id System.nanoTime() of time when Session object is created.
protected Params	params Additional parameters to send with next request
protected boolean	startView Whether currentView will be start view.
protected java.lang.Long	updated System.nanoTime() of begin(), update() and end() calls respectively.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionImpl(CtxCore ctx) Create session with current time as id.
	SessionImpl(CtxCore ctx, java.lang.Long id) Deserialization constructor (use existing id).

Method Summary

Modifier and Type	Method and Description
Session	addCrashReport(java.lang.Throwable t, boolean fatal) Send Crash Report to the server.
Session	addCrashReport(java.lang.Throwable t, boolean fatal, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> segments, java.lang.String... logs) Send Crash Report to the server.
Session	addLocation(double latitude, double longitude) Send location information to the server.
Session	addParam(java.lang.String key, java.lang.Object value) Add parameter to this session which will be sent along with next request.
Session	begin() Start this session, add corresponding request to queue.
Usage	changeDeviceIdWithMerge(java.lang.String id) Change device id with merging profiles on server, just set device id to new one.
Usage	changeDeviceIdWithoutMerge(java.lang.String id) Change device id without merging profiles on server, just set device id to new one.
void	end() End this session, add corresponding request to queue.
boolean	equals(java.lang.Object obj)
Event	event(java.lang.String key) Create event object, don't record it yet.
java.lang.Long	getBegan() System.currentTimeMillis() of Session.begin() call.
java.lang.String	getDeviceId() This method returns the Device ID that is currently used by the SDK.
java.lang.Long	getEnded() System.currentTimeMillis() of Session.end() call.
java.lang.Long	getId() System.nanoTime() of this instance creation.
static java.lang.String	getStoragePrefix()
int	hashCode()
boolean	isActive() Whether this session was started and haven't been ended yet.
Usage	login(java.lang.String id) Login function to set device (user) id on Countly server to the string specified here.
Usage	logout() Logout function to make current user anonymous (that is with random id according to ConfigCore.deviceIdStrategy and such).
void	recordEvent(Event event)
Usage	resetDeviceId(java.lang.String id)
boolean	restore(byte[] data)
java.lang.Long	storageId()
java.lang.String	storagePrefix()
byte[]	store()
Event	timedEvent(java.lang.String key) Get existing or create new timed event object, don't record it.
protected ly.count.sdk.java.internal.TimedEvents	timedEvents()
Session	update() Send update request to the server saying that user is still using the app.
User	user() Get current User Profile.
View	view(java.lang.String name) Identical to Usage.view(String, boolean), but without start parameter which is determined automatically based on whether this view is first in this session.
View	view(java.lang.String name, boolean start) Start new view.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected final java.lang.Long id

System.nanoTime() of time when Session object is created.

ctx

protected final CtxCore ctx

began

protected java.lang.Long began

System.nanoTime() of begin(), update() and end() calls respectively.

updated

protected java.lang.Long updated

System.nanoTime() of begin(), update() and end() calls respectively.

ended

protected java.lang.Long ended

System.nanoTime() of begin(), update() and end() calls respectively.

events

protected final java.util.List<Event> events

List of events still not added to request

params

protected final Params params

Additional parameters to send with next request

currentView

protected View currentView

Current view event, that is started, but not ended yet

startView

protected boolean startView

Whether currentView will be start view.

Constructor Detail

SessionImpl

protected SessionImpl(CtxCore ctx)

Create session with current time as id.

SessionImpl

public SessionImpl(CtxCore ctx,
                   java.lang.Long id)

Deserialization constructor (use existing id).

Method Detail

begin

public Session begin()

Description copied from interface: Session

Start this session, add corresponding request to queue.

Specified by:

begin in interface Session

Returns:

this instance for method chaining.

update

public Session update()

Description copied from interface: Session

Send update request to the server saying that user is still using the app.

Specified by:

update in interface Session

Returns:

this instance for method chaining.

end

public void end()

Description copied from interface: Session

End this session, add corresponding request to queue.

Specified by:

end in interface Session

isActive

public boolean isActive()

Description copied from interface: Session

Whether this session was started and haven't been ended yet.

Specified by:

isActive in interface Session

Returns:

true if session was started and haven't been ended yet, false otherwise

See Also:

Session.begin(), Session.end()

event

public Event event(java.lang.String key)

Description copied from interface: Usage

Create event object, don't record it yet. Creates begin request if this session hasn't yet been began.

Specified by:

event in interface Usage

Parameters:

key - key for this event, cannot be null or empty

Returns:

Event instance.

See Also:

Event.record()

timedEvent

public Event timedEvent(java.lang.String key)

Description copied from interface: Usage

Get existing or create new timed event object, don't record it. Creates begin request if this session hasn't yet been began.

Specified by:

timedEvent in interface Usage

Parameters:

key - key for this event, cannot be null or empty

Returns:

timed Event instance.

See Also:

to end timed event

timedEvents

protected ly.count.sdk.java.internal.TimedEvents timedEvents()

recordEvent

public void recordEvent(Event event)

Specified by:

recordEvent in interface ly.count.sdk.java.internal.EventImpl.EventRecorder

user

public User user()

Description copied from interface: Usage

Get current User Profile. Note that data is not downloaded from server. Only properties set in current app installation are returned in User object. Note that even when the CoreFeature.UserProfiles is disabled, this method still returns an object, yet any modifications to it won't result in any data stored or sent to the server/ //@ee Feature is not available in Countly Community Edition

Specified by:

user in interface Usage

Returns:

current User instance

addCrashReport

public Session addCrashReport(java.lang.Throwable t,
                              boolean fatal)

Description copied from interface: Usage

Send Crash Report to the server.

Specified by:

addCrashReport in interface Usage

Parameters:

t - Throwable to log

fatal - whether this crash report should be displayed as fatal in dashboard or not

Returns:

this instance for method chaining.

addCrashReport

public Session addCrashReport(java.lang.Throwable t,
                              boolean fatal,
                              java.lang.String name,
                              java.util.Map<java.lang.String,java.lang.String> segments,
                              java.lang.String... logs)

Description copied from interface: Usage

Send Crash Report to the server.

Specified by:

addCrashReport in interface Usage

Parameters:

t - Throwable to log

fatal - whether this crash report should be displayed as fatal in dashboard or not

name - (optional, can be null) name of the report, falls back to first line of stack trace by default

segments - (optional, can be null) additional crash segments map

logs - (optional, can be null) additional log lines (separated by \n) or comment about this crash report

Returns:

this instance for method chaining.

addLocation

public Session addLocation(double latitude,
                           double longitude)

Description copied from interface: Usage

Send location information to the server.

Specified by:

addLocation in interface Usage

Parameters:

latitude - geographical latitude of the user

longitude - geographical longitude of the user

Returns:

this instance for method chaining.

view

public View view(java.lang.String name,
                 boolean start)

Description copied from interface: Usage

Start new view. In case previous view in this session is not ended yet, it will be ended automatically. In case session ends and last view haven't been ended yet, it will be ended automatically. Creates begin request if this session hasn't yet been began.

Specified by:

view in interface Usage

Parameters:

name - String representing name of this View

start - whether this view is first in current application launch

Returns:

new but already started View, you're responsible for its ending by calling View.stop(boolean)

view

public View view(java.lang.String name)

Description copied from interface: Usage

Identical to Usage.view(String, boolean), but without start parameter which is determined automatically based on whether this view is first in this session. Creates begin request if this session hasn't yet been began.

Specified by:

view in interface Usage

Parameters:

name - String representing name of this View

Returns:

new but already started View, you're responsible for its ending by calling View.stop(boolean)

login

public Usage login(java.lang.String id)

Description copied from interface: Usage

Login function to set device (user) id on Countly server to the string specified here. Closes current session, then starts new one automatically if ConfigCore.autoSessionsTracking is on, acquires device id.

Specified by:

login in interface Usage

Parameters:

id - new user / device id string, cannot be empty

logout

public Usage logout()

Description copied from interface: Usage

Logout function to make current user anonymous (that is with random id according to ConfigCore.deviceIdStrategy and such). Obviously makes sense only after a call to Usage.login(String), so it throws error or does nothing (depending on ConfigCore.testMode) if current id wasn't set using Usage.login(String). Closes current session.

Specified by:

logout in interface Usage

getDeviceId

public java.lang.String getDeviceId()

Description copied from interface: Usage

This method returns the Device ID that is currently used by the SDK.

Specified by:

getDeviceId in interface Usage

resetDeviceId

public Usage resetDeviceId(java.lang.String id)

Specified by:

resetDeviceId in interface Usage

changeDeviceIdWithMerge

public Usage changeDeviceIdWithMerge(java.lang.String id)

Description copied from interface: Usage

Change device id with merging profiles on server, just set device id to new one.

Specified by:

changeDeviceIdWithMerge in interface Usage

Parameters:

id - new user / device id string, cannot be empty

changeDeviceIdWithoutMerge

public Usage changeDeviceIdWithoutMerge(java.lang.String id)

Description copied from interface: Usage

Change device id without merging profiles on server, just set device id to new one.

Specified by:

changeDeviceIdWithoutMerge in interface Usage

Parameters:

id - new user / device id string, cannot be empty

addParam

public Session addParam(java.lang.String key,
                        java.lang.Object value)

Description copied from interface: Usage

Add parameter to this session which will be sent along with next request.

Specified by:

addParam in interface Usage

Parameters:

key - name of parameter

value - value of parameter

Returns:

this instance for method chaining.

getId

public java.lang.Long getId()

Description copied from interface: Session

System.nanoTime() of this instance creation.

Specified by:

getId in interface Session

getBegan

public java.lang.Long getBegan()

Description copied from interface: Session

System.currentTimeMillis() of Session.begin() call.

Specified by:

getBegan in interface Session

getEnded

public java.lang.Long getEnded()

Description copied from interface: Session

System.currentTimeMillis() of Session.end() call.

Specified by:

getEnded in interface Session

storageId

public java.lang.Long storageId()

Specified by:

storageId in interface Storable

storagePrefix

public java.lang.String storagePrefix()

Specified by:

storagePrefix in interface Storable

getStoragePrefix

public static java.lang.String getStoragePrefix()

store

public byte[] store()

Specified by:

store in interface Byteable

restore

public boolean restore(byte[] data)

Specified by:

restore in interface Byteable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object