eqatec.analytics.monitor

Interface IAnalyticsMonitor

public interface IAnalyticsMonitor

The interface for the analytics monitor. Call Start to start using the monitor and Stop to end using the monitor. Calls made on the monitor without start being called will not result in any activity being recorded. Obtain an instance of this class by making a create call on the AnalyticsMonitorFactory or use the AnalyticsMonitorFacade for simple integration.

See Also:

AnalyticsMonitorFactory, AnalyticsMonitorFacade

Method Summary

Methods

Modifier and Type	Method and Description
void	addVersionAvailableListener(IVersionAvailableListener versionAvailableListener) Adds the version available listener.
void	close() Closing the monitor instance
void	forceSync() Explicitly force a synchronization of the current information with the analytics server.
AnalyticsMonitorStatus	getStatus() Get the current status for the monitor instance
void	lookup(java.lang.String lookupKey, int timeoutInMilliseconds, ILookupCallback callback) Performs an async lookup on the servers for the given key and returns the result in a strongly typed instance indicating the result of the lookup
void	removeVersionAvailableListener(IVersionAvailableListener versionAvailableListener) Removes the version available listener.
void	sendLog(java.lang.String logMessage) Sending a simple log message.
void	sendLog(java.lang.String logMessage, byte[] data, java.lang.String mimeType) Send a log message with a associated data
void	sendLog(java.lang.String messageFormat, java.lang.Object... args) Sending a simple formatted log message.
void	setInstallationInfo(java.lang.String installationID) Associate an installation ID with the current monitor and the current session
void	setInstallationInfo(java.lang.String installationID, java.util.Map<java.lang.String,java.lang.String> installationProperties) Associate an installation ID with the current monitor and allows for further installation properties to be associated with the current session
void	start() Starting the monitor.
void	stop() Stop the monitor.
void	stop(int waitForCompletionInMilliseconds) Stop the monitor.
void	trackException(java.lang.Throwable exception) Track an exception.
void	trackException(java.lang.Throwable exception, java.lang.String message) Track an exception with a context message.
void	trackException(java.lang.Throwable exception, java.lang.String format, java.lang.Object... args) Track an exception with a formatted context message.
void	trackFeature(java.lang.String featureName) Track a named feature.
void	trackFeatureCancel(java.lang.String featureName) Stop an ongoing time tracking of a named feature within registering the time.
void	trackFeatures(java.lang.String[] featureName) Track an array of named feature.
TimingScope	trackFeatureStart(java.lang.String featureName) Start time tracking of a named feature.
int	trackFeatureStop(java.lang.String featureName) Stop time tracking of a named feature.
void	trackFeatureValue(java.lang.String featureName, long featureValue) Track a value associated with a feature name.

Method Detail

addVersionAvailableListener

void addVersionAvailableListener(IVersionAvailableListener versionAvailableListener)

Adds the version available listener. Information on newer versions of the product as provided by the server is delivered on this listener

Parameters:

versionAvailableListener - the version available listener

removeVersionAvailableListener

void removeVersionAvailableListener(IVersionAvailableListener versionAvailableListener)

Removes the version available listener.

Parameters:

versionAvailableListener - the version available listener

start

void start()

Starting the monitor. Note that none of the tracking calls have any effect before this call. Repeated calls have no effect as only one monitoring session can be started

trackException

void trackException(java.lang.Throwable exception)

Track an exception. Delivers the exception information to the server as soon as possible.

Parameters:

exception - the exception

trackException

void trackException(java.lang.Throwable exception,
                  java.lang.String message)

Track an exception with a context message. Delivers the exception information to the server as soon as possible.

Parameters:

exception - the exception

message - the message

trackException

void trackException(java.lang.Throwable exception,
                  java.lang.String format,
                  java.lang.Object... args)

Track an exception with a formatted context message. Delivers the exception information to the server as soon as possible

Parameters:

exception - the exception

format - the format string

args - the arguments to the format

trackFeature

void trackFeature(java.lang.String featureName)

Track a named feature. Note the recommended use of a one-level dot-notation for feature naming to allow for better grouping of related features. Tracked features are not delivered to the server immediately but are piggy-backed on the next delivery.

Parameters:

featureName - the feature name

trackFeatures

void trackFeatures(java.lang.String[] featureName)

Track an array of named feature. Note the recommended use of a one-level dot-notation for feature naming to allow for better grouping of related features. Tracked features are not delivered to the server immediately but are piggy-backed on the next delivery.

Parameters:

featureName - the feature name

trackFeatureStart

TimingScope trackFeatureStart(java.lang.String featureName)

Start time tracking of a named feature. Note that the timing is not recorded before a matching trackFeatureStop has been called and that there is no support for multiple concurrent timings of the same named feature so multiple start calls without a matching stop for the same feature will have no effect.

Parameters:

featureName - the feature name

Returns:

a TimingScope instance encapsulating the timing of this named feature

trackFeatureStop

int trackFeatureStop(java.lang.String featureName)

Stop time tracking of a named feature. Note that this has no effect if there has not been a matching trackFeatureStart.

Parameters:

featureName - the feature name

Returns:

the number of milliseconds tracked or 0 if nothing has been tracked

trackFeatureCancel

void trackFeatureCancel(java.lang.String featureName)

Stop an ongoing time tracking of a named feature within registering the time. This call can be used in the feature being time did not complete as expected such as an exception occurring or the user canceling the activity.

Parameters:

featureName - the feature name

trackFeatureValue

void trackFeatureValue(java.lang.String featureName,
                     long featureValue)

Track a value associated with a feature name. This tracking will associate the given value with the feature and allow you to inspect e.g. the distribution of value server side

Parameters:

featureName - the feature name

featureValue - the value for the feature

sendLog

void sendLog(java.lang.String logMessage)

Sending a simple log message. The message is delivered to the server as soon as possible.

Parameters:

logMessage - the log message

sendLog

void sendLog(java.lang.String messageFormat,
           java.lang.Object... args)

Sending a simple formatted log message. The message is delivered to the server as soon as possible.

Parameters:

messageFormat - the message format

args - the args

sendLog

void sendLog(java.lang.String logMessage,
           byte[] data,
           java.lang.String mimeType)

Send a log message with a associated data

Parameters:

logMessage - the message

data - the associated data

mimeType - the optional mime type of the data

forceSync

void forceSync()

Explicitly force a synchronization of the current information with the analytics server. This call is not expected to be used in a standard setup but may be helpful in occasionally connected scenarios. If you created the monitor instance by explicitly setting SynchronizeAutomatically to false this method is how you can force the monitor to synchronize.

See Also:

AnalyticsMonitorSettings

setInstallationInfo

void setInstallationInfo(java.lang.String installationID,
                       java.util.Map<java.lang.String,java.lang.String> installationProperties)

Associate an installation ID with the current monitor and allows for further installation properties to be associated with the current session

Parameters:

installationID -

installationProperties -

setInstallationInfo

void setInstallationInfo(java.lang.String installationID)

Associate an installation ID with the current monitor and the current session

Parameters:

installationID -

stop

void stop()

Stop the monitor. By stopping the monitor an attempt to deliver the last data to the servers are made. If data could not be delivered it will be attempted to deliver the data again on the next start of the monitor with the same product id

stop

void stop(int waitForCompletionInMilliseconds)

Stop the monitor. By stopping the monitor an attempt to deliver the last data to the servers are made. If data could not be delivered it will be attempted to deliver the data again on the next start of the monitor with the same product id

Parameters:

waitForCompletionInMilliseconds - the milliseconds to wait for the final data to be delivered

getStatus

AnalyticsMonitorStatus getStatus()

Get the current status for the monitor instance

Returns:

the current status

lookup

void lookup(java.lang.String lookupKey,
          int timeoutInMilliseconds,
          ILookupCallback callback)

Performs an async lookup on the servers for the given key and returns the result in a strongly typed instance indicating the result of the lookup

Parameters:

lookupKey - the key to lookup

timeoutInMilliseconds - the timeout before abandoning the lookup, in milliseconds. 0 means no timeout

callback - the interface on which the async callback is performed

See Also:

LookupReply

close

void close()

Closing the monitor instance