oracle.maf.api.analytics

Class AnalyticsLogRecord

Object

java.util.logging.LogRecord

oracle.maf.api.analytics.AnalyticsLogRecord

All Implemented Interfaces:

java.io.Serializable

public class AnalyticsLogRecord
extends java.util.logging.LogRecord

AnalyticsLogRecord extends LogRecord. These objects are used to pass logging requests between the logging framework and individual log Handlers. This class is not thread safe as these objects are not shared between threads.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnalyticsLogRecord(java.util.logging.Level level, String eventName) Constructor of AnalyticsLogRecord
AnalyticsLogRecord(java.util.logging.Level level, String category, String eventName, JSONObject payload) Constructor of AnalyticsLogRecord.
AnalyticsLogRecord(java.util.logging.LogRecord lr) Constructor of AnalyticsLogRecord

Method Summary

Modifier and Type	Method and Description
String	getCategory()
String	getFeatureId()
String	getName()
JSONObject	getPayload()
static String	getSessionId()
String	getUsername() This method returns the username using which the user has logged into the secured feature.
void	setCategory(String category) This method is used to set the category of events.
void	setName(String name) This method is used to set the name of the event and it cannot be null.
void	setPayload(JSONObject payload) This method sets the payload which represents the 'properties' object of the event being logged.
JSONObject	toJSON()
String	toString()

Methods inherited from class java.util.logging.LogRecord

getLevel, getLoggerName, getMessage, getMillis, getParameters, getResourceBundle, getResourceBundleName, getSequenceNumber, getSourceClassName, getSourceMethodName, getThreadID, getThrown, setLevel, setLoggerName, setMessage, setMillis, setParameters, setResourceBundle, setResourceBundleName, setSequenceNumber, setSourceClassName, setSourceMethodName, setThreadID, setThrown

Methods inherited from class Object

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

Constructor Detail

AnalyticsLogRecord

public AnalyticsLogRecord(java.util.logging.Level level,
                          String eventName)

Constructor of AnalyticsLogRecord

Parameters:

level - - Level to be set for AnalyticsLogRecord

eventName - - Name to be set for AnalyticsLogRecord

AnalyticsLogRecord

public AnalyticsLogRecord(java.util.logging.LogRecord lr)

Constructor of AnalyticsLogRecord

Parameters:

lr - - LogRecord from which to create an AnalyticsLogRecord object.

AnalyticsLogRecord

public AnalyticsLogRecord(java.util.logging.Level level,
                          String category,
                          String eventName,
                          JSONObject payload)

Constructor of AnalyticsLogRecord. It will start the session if one has not already been started.

Parameters:

level - - Level to be set for AnalyticsLogRecord

category - - Category to be set for AnalyticsLogRecord

eventName - - Name to be set for AnalyticsLogRecord

payload - - JSONObject which will represent the 'properties' object for the AnalyticsLogRecord

Method Detail

getSessionId

public static String getSessionId()

Returns:

This method returns the sessionId. It's a unique identifier which represents the current session.

setName

public void setName(String name)

This method is used to set the name of the event and it cannot be null.

Parameters:

name - - It represents the name of the event.

Throws:

AdfException - - It throws AdfException if name is null.

getName

public String getName()

Returns:

name of the event.

setCategory

public void setCategory(String category)

This method is used to set the category of events. If MCS is the backend to which the events are logged then there are only 2 types of categories which are supported: custom and system.

Parameters:

category - custom - All the events which are logged from user application has to be of type custom. Its a default category. These events will be analyzed by MCS to generate reports. system - If events are being published to MCS then only 'context, sessionStart & sessionEnd event' are allowed to be of type system.

getCategory

public String getCategory()

Returns:

- returns category associated with the event.

setPayload

public void setPayload(JSONObject payload)

This method sets the payload which represents the 'properties' object of the event being logged.

Parameters:

payload - - It is a JSONObject object with Key/Value pair of type String.

getPayload

public JSONObject getPayload()

Returns:

JSONObject which represents the 'properties' of the events being logged.

getUsername

public String getUsername()

This method returns the username using which the user has logged into the secured feature. If the feature is not secured then it will return null.

Returns:

username - If the feature is secure, it will return the username using which user has logged in else it will return null.

getFeatureId

public String getFeatureId()

Returns:

current featureId.

toJSON

public JSONObject toJSON()

Returns:

- This method returns the JSON representation of the AnalyticsLogRecord object. It represents the event which will be logged.

toString

public String toString()

Overrides:

toString in class Object

Returns:

- This method returns the String representation of the AnalyticsLogRecord object. It represents the event which will be logged