eqatec.analytics.monitor

Class AnalyticsMonitorFactory

java.lang.Object

eqatec.analytics.monitor.AnalyticsMonitorFactory

public class AnalyticsMonitorFactory
extends java.lang.Object

The factory for creating IAnalyticsMonitor instances. This is the entry point for interacting with the analytics monitoring

Method Summary

Methods

Modifier and Type	Method and Description
static IAnalyticsMonitor	create(IAnalyticsMonitorSettings settings) Deprecated. This method is replaced with createMonitor
static IAnalyticsMonitor	create(java.lang.String productId, Version version) Deprecated. This method is replaced by createMonitor
static IStorage	createFileStorage(java.lang.String folder) Creates an instance of the IStorage interface that stores data in a specified folder.
static IAnalyticsMonitor	createMonitor(IAnalyticsMonitorSettings settings) Returns a monitor instance for the settings.
static IAnalyticsMonitor	createMonitor(java.lang.String productId, Version version) Returns a monitor instance for the given product id and application version
static IAnalyticsMonitorSettings	createSettings(java.lang.String productId, Version version) Creates an instance of the settings class to customize the monitor
static ILogAnalyticsMonitor	createTraceMonitor() Creates a simple ILogAnalyticsMonitor instance that logs messages to System.out.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Deprecated
public static IAnalyticsMonitor create(java.lang.String productId,
                                  Version version)
                                throws java.lang.IllegalArgumentException,
                                       java.net.URISyntaxException

Deprecated. This method is replaced by createMonitor

Returns a monitor instance for the given product id and application version

Parameters:

productId - the product id

version - the version of the containing application in the format major.minor.build.revision

Returns:

a monitor instance

Throws:

java.lang.IllegalArgumentException

java.net.URISyntaxException

See Also:

IAnalyticsMonitor

createMonitor

public static IAnalyticsMonitor createMonitor(java.lang.String productId,
                              Version version)
                                       throws java.lang.IllegalArgumentException,
                                              java.net.URISyntaxException

Returns a monitor instance for the given product id and application version

Parameters:

productId - the product id

version - the version of the containing application in the format major.minor.build.revision

Returns:

a monitor instance

Throws:

java.lang.IllegalArgumentException

java.net.URISyntaxException

See Also:

IAnalyticsMonitor

create

@Deprecated
public static IAnalyticsMonitor create(IAnalyticsMonitorSettings settings)

Deprecated. This method is replaced with createMonitor

Returns a monitor instance for the settings.

Parameters:

settings - the settings object for creating a monitor instance

Returns:

the analytics monitor instance

Throws:

java.lang.IllegalArgumentException

See Also:

IAnalyticsMonitor, AnalyticsMonitorSettings

createMonitor

public static IAnalyticsMonitor createMonitor(IAnalyticsMonitorSettings settings)

Returns a monitor instance for the settings.

Parameters:

settings - the settings object for creating a monitor instance

Returns:

the analytics monitor instance

Throws:

java.lang.IllegalArgumentException

See Also:

IAnalyticsMonitor, AnalyticsMonitorSettings

createFileStorage

public static IStorage createFileStorage(java.lang.String folder)
                                  throws java.io.IOException

Creates an instance of the IStorage interface that stores data in a specified folder. This instance can be used when creating the monitor instance by assigning it to the StorageInterface on the AnalyticsMonitorSettings instance.

Parameters:

folder - the folder to persist data to

Returns:

an IStorage instance that persist data to the file system

Throws:

java.io.IOException - if the specified folder is illegal or cannot be created

createTraceMonitor

public static ILogAnalyticsMonitor createTraceMonitor()

Creates a simple ILogAnalyticsMonitor instance that logs messages to System.out. You can assign this instance to the LoggingInterface on the AnalyticsMonitorSettings instance to receive the internal messages from the monitor

Returns:

an ILogAnalyticsMonitor that log messages to standard output

createSettings

public static IAnalyticsMonitorSettings createSettings(java.lang.String productId,
                                       Version version)
                                                throws java.lang.IllegalArgumentException,
                                                       java.net.URISyntaxException

Creates an instance of the settings class to customize the monitor

Parameters:

productId - the product id

version - the version of the application

Returns:

an instance of the settings class

Throws:

java.lang.IllegalArgumentException - if the product id is not correctly formatted

java.net.URISyntaxException