oracle.maf.api.analytics

Class McsContextProvider

Object

oracle.maf.api.analytics.McsContextProvider

All Implemented Interfaces:

ContextProvider

public class McsContextProvider
extends Object
implements ContextProvider

Context event contains information like timezone, geolocation & device information which will be sent to MCS for generating analytical reports. McsContextProvider will contain following fields in properties for context event: latitude, longitude, timezone, model, osName, osVersion. Generation of context event is enabled by default. If timezone, geolocation & device information needs to be added to represent the context of the analytical events then McsContextProvider needs to be specified for 'contextProviderClassName' property in logging.properties. eg:

 oracle.maf.api.analytics.McsAnalyticsHandler.contextProviderClassName = oracle.maf.api.analytics.McsContextProvider
 

Constructor Summary

Constructors

Constructor and Description
McsContextProvider()

Method Summary

Modifier and Type	Method and Description
JSONObject	generateContext() This method will generate the JSON object which will contain fields which MCS expects in the 'context' event, except for username, carrier, manufacturer and osBuild Below defined fields will be added to context event if logging.properties contains 'McsContextProvider' for 'contextProviderClassName' property.

Methods inherited from class Object

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

Constructor Detail

McsContextProvider

public McsContextProvider()

Method Detail

generateContext

public JSONObject generateContext()

This method will generate the JSON object which will contain fields which MCS expects in the 'context' event, except for username, carrier, manufacturer and osBuild Below defined fields will be added to context event if logging.properties contains 'McsContextProvider' for 'contextProviderClassName' property. eg:

 oracle.maf.api.analytics.McsAnalyticsHandler.contextProviderClassName = oracle.maf.api.analytics.McsContextProvider
 

 
  timezone - mobile device's offset from UTC in seconds.
  model - mobile device model name.
  osName - mobile device operating system name.
  osVersion - mobile device operating system version.
  latitude - mobile device's GPS latitude.
  longitude - mobile device's GPS longitude.
  latitude and longitude information will get translated into
  City/State/Country/PostalCode by MCS
 
 

userName - If userName needs to be added via framework then it needs to be enabled in logging.properties (recordUsername should be set to 'true'). If true, McsAnalyticsHandler will add userName to 'properties' object. A new context event will also be generated whenever there is a change in userName.

Specified by:

generateContext in interface ContextProvider

Returns:

JSONObject represents 'properties' for context event. McsAnalyticsHandler will wrap this object to create context event.