ly.count.sdk.java.internal

Class ModuleDeviceIdCore

java.lang.Object

ly.count.sdk.java.internal.ModuleBase

ly.count.sdk.java.internal.ModuleDeviceIdCore

All Implemented Interfaces:

Module

public class ModuleDeviceIdCore
extends ModuleBase

Main device id manipulation class. Contract:

• Must be device id strategy agnostic.
• Must give developer an ability to override any id.
• Must be able to manage different branches of ids: at least Countly device id & push device token.

Constructor Summary

Constructors

Constructor and Description
ModuleDeviceIdCore()

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.Future<ConfigCore.DID>	acquireId(CtxCore ctx, ConfigCore.DID holder, boolean fallbackAllowed, Tasks.Callback<ConfigCore.DID> callback)
protected ConfigCore.DID	acquireIdSync(CtxCore ctx, ConfigCore.DID holder, boolean fallbackAllowed) Synchronously gets id of the strategy supplied.
protected void	callOnDeviceId(CtxCore ctx, ConfigCore.DID id, ConfigCore.DID old)
void	changeDeviceId(CtxCore ctx, java.lang.String id, boolean withMerge) Resetting id without merging profiles on server: End current session if any Begin new session with new id if previously ended a session
java.lang.Integer	getFeature()
void	init(InternalConfig config) All initialization must be done in this method, not constructor.
void	login(CtxCore ctx, java.lang.String id) Logging into app-specific account: - reset device id and notify modules; - send corresponding request to server.
void	logout(CtxCore ctx) Logging out from app-specific account and reverting back to previously used id if any: - nullify device id and notify modules; - send corresponding request to server.
void	onContextAcquired(CtxCore ctx) Regular logic of acquiring id of specified strategy and migration from legacy SDK.
void	onDeviceId(CtxCore ctx, ConfigCore.DID deviceId, ConfigCore.DID oldDeviceId) Device ID has been acquired from device id provider.
static void	registerGenerator(int index, DeviceIdGenerator generator)
void	stop(CtxCore ctx, boolean clear) App user decided to opt out from analytics or developer changed important preferences.

Methods inherited from class ly.count.sdk.java.internal.ModuleBase

isActive, onActivityCreated, onActivityDestroyed, onActivityPaused, onActivityResumed, onActivitySaveInstanceState, onActivityStarted, onActivityStopped, onConfigurationChanged, onLimitedContextAcquired, onRequest, onRequestCompleted, onSessionBegan, onSessionEnded, onUserChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeviceIdCore

public ModuleDeviceIdCore()

Method Detail

registerGenerator

public static void registerGenerator(int index,
                                     DeviceIdGenerator generator)

init

public void init(InternalConfig config)
          throws java.lang.IllegalArgumentException

Description copied from interface: Module

All initialization must be done in this method, not constructor. This method is guaranteed to be run right after constructor with no module-related actions in between.

Specified by:

init in interface Module

Overrides:

init in class ModuleBase

Parameters:

config - Countly configuration object: can be stored locally if needed.

Throws:

java.lang.IllegalArgumentException - in case supplied InternalConfig is not consistent.

onContextAcquired

public void onContextAcquired(CtxCore ctx)

Regular logic of acquiring id of specified strategy and migration from legacy SDK.

Specified by:

onContextAcquired in interface Module

Overrides:

onContextAcquired in class ModuleBase

Parameters:

ctx - Ctx

onDeviceId

public void onDeviceId(CtxCore ctx,
                       ConfigCore.DID deviceId,
                       ConfigCore.DID oldDeviceId)

Description copied from interface: Module

Device ID has been acquired from device id provider. Can be invoked multiple times throughout Module lifecycle. Parameters can be instance equal (==), meaning that id haven't changed.

Specified by:

onDeviceId in interface Module

Overrides:

onDeviceId in class ModuleBase

Parameters:

ctx - Ctx to run in

deviceId - deviceId valid from now on

oldDeviceId - deviceId valid previously if any

getFeature

public java.lang.Integer getFeature()

Returns:

Module feature index if any

login

public void login(CtxCore ctx,
                  java.lang.String id)

Logging into app-specific account: - reset device id and notify modules; - send corresponding request to server.

Parameters:

ctx - ctx to run in

id - device id to change to

logout

public void logout(CtxCore ctx)

Logging out from app-specific account and reverting back to previously used id if any: - nullify device id and notify modules; - send corresponding request to server.

Parameters:

ctx - context to run in

changeDeviceId

public void changeDeviceId(CtxCore ctx,
                           java.lang.String id,
                           boolean withMerge)

Resetting id without merging profiles on server:

• End current session if any
• Begin new session with new id if previously ended a session

Parameters:

ctx - context to run in

id - new user id

acquireId

protected java.util.concurrent.Future<ConfigCore.DID> acquireId(CtxCore ctx,
                                                                ConfigCore.DID holder,
                                                                boolean fallbackAllowed,
                                                                Tasks.Callback<ConfigCore.DID> callback)

acquireIdSync

protected ConfigCore.DID acquireIdSync(CtxCore ctx,
                                       ConfigCore.DID holder,
                                       boolean fallbackAllowed)

Synchronously gets id of the strategy supplied. In case strategy is not available, returns a fallback strategy. In case strategy is available but id cannot be acquired right now, returns null.

Parameters:

ctx - Ctx to run in

holder - DID object which holds strategy and possibly other info for id generation

fallbackAllowed - whether to automatically fallback to any available alternative or not

Returns:

ConfigCore.DID instance with an id

callOnDeviceId

protected void callOnDeviceId(CtxCore ctx,
                              ConfigCore.DID id,
                              ConfigCore.DID old)

stop

public void stop(CtxCore ctx,
                 boolean clear)

Description copied from interface: Module

App user decided to opt out from analytics or developer changed important preferences. Clear all module-related data, close any resources and prepare to start from clean sheet. This method is guaranteed to be the latest method call to this module instance.

• Stop all tasks, clear all context references.
• Not a single function call can be fired from this object after the method returns.
• Remove all module-related Storable files if clear is true

Specified by:

stop in interface Module

Overrides:

stop in class ModuleBase

Parameters:

ctx - CtxCore to run in

clear - true if module must clear it's data files, false otherwise