eqatec.analytics.monitor

Class AnalyticsMonitorSettings

java.lang.Object

eqatec.analytics.monitor.AnalyticsMonitorSettings

All Implemented Interfaces:

IAnalyticsMonitorSettings

public class AnalyticsMonitorSettings
extends java.lang.Object
implements IAnalyticsMonitorSettings

The AnalyticsMonitorSettings class. Encapsulates settings controlling the creation of the analytics monitoring.

Constructor Summary

Constructors

Constructor and Description
AnalyticsMonitorSettings(java.lang.String productId, Version version) Instantiates a new analytics monitor settings.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDailyNetworkUtilizationInKB() Gets the current limit for the network utilization for the monitor.
LocationCoordinates	getLocationCoordinates() Get the location of the monitor as GPS coordinates.
ILogAnalyticsMonitor	getLoggingInterface() Gets the logging interface.
int	getMaxStorageSizeInKB() Gets the maximum size in KB for the data stored by the monitor.
java.util.UUID	getProductId() Gets the product id.
java.net.URI	getServerUri() Gets the server uri.
IStorage	getStorageInterface() Gets the current storage implementation.
long	getStorageSaveInterval() Gets the storage save interval in milliseconds.
boolean	getSynchronizeAutomatically() Get whether the monitor should automatically synchronize (the default) or if it should only attempt to synchronize on an explicit call to ForceSync
boolean	getTestMode() Gets the test mode.
boolean	getUseHttps() Get whether SSL is configured for the communication
Version	getVersion() Gets the registered version of the application.
void	setDailyNetworkUtilizationInKB(int dailyUtilizationLimit) Sets the limit of the daily network utilization.
void	setLoggingInterface(ILogAnalyticsMonitor loggingInterface) Sets the logging interface.
void	setMaxStorageSizeInKB(int storageLimit) Sets the limit of the data stored by the monitor.
void	setServerUri(java.net.URI serverUri) Sets the server uri.
void	setStorageInterface(IStorage storage) Sets the storage.
void	setStorageSaveInterval(long storageSaveInterval) Sets the storage save interval.
void	setSynchronizeAutomatically(boolean syncAutomatically) Set whether the monitor should automatically synchronize or not.
void	setTestMode(boolean testMode) Sets the analytics monitor into test mode.
void	setUseSsl(boolean useSsl) Set whether the monitor should utilize SSL when communicating with the server.
void	setVersion(Version version) Sets the version of the application

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsMonitorSettings

public AnalyticsMonitorSettings(java.lang.String productId,
                        Version version)
                         throws java.lang.IllegalArgumentException

Instantiates a new analytics monitor settings.

Parameters:

productId - the product id

version - the version of the application

Throws:

java.lang.IllegalArgumentException - the illegal argument exception

Method Detail

getProductId

public java.util.UUID getProductId()

Description copied from interface: IAnalyticsMonitorSettings

Gets the product id.

Specified by:

getProductId in interface IAnalyticsMonitorSettings

Returns:

the product id

setVersion

public void setVersion(Version version)

Description copied from interface: IAnalyticsMonitorSettings

Sets the version of the application

Specified by:

setVersion in interface IAnalyticsMonitorSettings

Parameters:

version - the new version

getVersion

public Version getVersion()

Description copied from interface: IAnalyticsMonitorSettings

Gets the registered version of the application.

Specified by:

getVersion in interface IAnalyticsMonitorSettings

Returns:

the version

setLoggingInterface

public void setLoggingInterface(ILogAnalyticsMonitor loggingInterface)

Description copied from interface: IAnalyticsMonitorSettings

Sets the logging interface. Provide a specific implementation to receive informational messages about the internals of the analytics monitoring

Specified by:

setLoggingInterface in interface IAnalyticsMonitorSettings

Parameters:

loggingInterface - the new logging interface

See Also:

ILogAnalyticsMonitor

getLoggingInterface

public ILogAnalyticsMonitor getLoggingInterface()

Description copied from interface: IAnalyticsMonitorSettings

Gets the logging interface.

Specified by:

getLoggingInterface in interface IAnalyticsMonitorSettings

Returns:

the logging interface

See Also:

ILogAnalyticsMonitor

setStorageInterface

public void setStorageInterface(IStorage storage)

Description copied from interface: IAnalyticsMonitorSettings

Sets the storage. Provide a specific implementation to control where the binary data is persisted

Specified by:

setStorageInterface in interface IAnalyticsMonitorSettings

Parameters:

storage - the new storage

See Also:

IStorage

getStorageInterface

public IStorage getStorageInterface()

Description copied from interface: IAnalyticsMonitorSettings

Gets the current storage implementation.

Specified by:

getStorageInterface in interface IAnalyticsMonitorSettings

Returns:

the storage

setStorageSaveInterval

public void setStorageSaveInterval(long storageSaveInterval)

Description copied from interface: IAnalyticsMonitorSettings

Sets the storage save interval. This is the interval at which the internal state of the monitor is automatically persisted to storage. Note the the state is also persisted to storage before each sending operation

Specified by:

setStorageSaveInterval in interface IAnalyticsMonitorSettings

Parameters:

storageSaveInterval - the new storage save interval in milliseconds

getStorageSaveInterval

public long getStorageSaveInterval()

Description copied from interface: IAnalyticsMonitorSettings

Gets the storage save interval in milliseconds.

Specified by:

getStorageSaveInterval in interface IAnalyticsMonitorSettings

Returns:

the storage save interval

setServerUri

public void setServerUri(java.net.URI serverUri)
                  throws java.net.MalformedURLException,
                         java.net.URISyntaxException

Description copied from interface: IAnalyticsMonitorSettings

Sets the server uri. Provide a specific uri if you wish to specifically route the data to an endpoint other than the default provided.

Specified by:

setServerUri in interface IAnalyticsMonitorSettings

Parameters:

serverUri - the new server uri

Throws:

java.net.MalformedURLException - the malformed url exception

java.net.URISyntaxException - the uRI syntax exception

getServerUri

public java.net.URI getServerUri()

Description copied from interface: IAnalyticsMonitorSettings

Gets the server uri. If not set the default server uri endpoint is returned

Specified by:

getServerUri in interface IAnalyticsMonitorSettings

Returns:

the server uri

getSynchronizeAutomatically

public boolean getSynchronizeAutomatically()

Description copied from interface: IAnalyticsMonitorSettings

Get whether the monitor should automatically synchronize (the default) or if it should only attempt to synchronize on an explicit call to ForceSync

Specified by:

getSynchronizeAutomatically in interface IAnalyticsMonitorSettings

Returns:

true if monitor is set to synchronize automatically

setSynchronizeAutomatically

public void setSynchronizeAutomatically(boolean syncAutomatically)

Description copied from interface: IAnalyticsMonitorSettings

Set whether the monitor should automatically synchronize or not. If the monitor is set to automatically synchronize the monitor will periodically attempt to synchronize the current state to the server. If not set to synchronize the monitor will not attempt to synchronize unless an explicit call has been made to force sync

Specified by:

setSynchronizeAutomatically in interface IAnalyticsMonitorSettings

getDailyNetworkUtilizationInKB

public int getDailyNetworkUtilizationInKB()

Description copied from interface: IAnalyticsMonitorSettings

Gets the current limit for the network utilization for the monitor. The monitor accumulates the payload on a daily basis and if the utlization limit is exceeded the transmission of data is aborted.

Specified by:

getDailyNetworkUtilizationInKB in interface IAnalyticsMonitorSettings

Returns:

the limit for the network utilization

setDailyNetworkUtilizationInKB

public void setDailyNetworkUtilizationInKB(int dailyUtilizationLimit)

Description copied from interface: IAnalyticsMonitorSettings

Sets the limit of the daily network utilization. The monitor will not honor settings limitations below 10 KB. If you wish to stop the monitor from contacting the server you should refrain from calling the Start method.

Specified by:

setDailyNetworkUtilizationInKB in interface IAnalyticsMonitorSettings

getMaxStorageSizeInKB

public int getMaxStorageSizeInKB()

Description copied from interface: IAnalyticsMonitorSettings

Gets the maximum size in KB for the data stored by the monitor.

Specified by:

getMaxStorageSizeInKB in interface IAnalyticsMonitorSettings

Returns:

the limit of the storage in KB

setMaxStorageSizeInKB

public void setMaxStorageSizeInKB(int storageLimit)

Description copied from interface: IAnalyticsMonitorSettings

Sets the limit of the data stored by the monitor. The monitor will not honor settings limitations below 1 KB since the monitor has some meta data that it needs to store

Specified by:

setMaxStorageSizeInKB in interface IAnalyticsMonitorSettings

setTestMode

public void setTestMode(boolean testMode)

Description copied from interface: IAnalyticsMonitorSettings

Sets the analytics monitor into test mode. Test mode should only be set for non-production settings. Test mode allows for various testing setups to be invoked on the server such as returning information on non-public product releases

Specified by:

setTestMode in interface IAnalyticsMonitorSettings

Parameters:

testMode - the new test mode

getTestMode

public boolean getTestMode()

Description copied from interface: IAnalyticsMonitorSettings

Gets the test mode.

Specified by:

getTestMode in interface IAnalyticsMonitorSettings

Returns:

the test mode

setUseSsl

public void setUseSsl(boolean useSsl)
               throws java.net.MalformedURLException,
                      java.net.URISyntaxException

Description copied from interface: IAnalyticsMonitorSettings

Set whether the monitor should utilize SSL when communicating with the server. If the ServerUri is set explicitly this property is ignored

Specified by:

setUseSsl in interface IAnalyticsMonitorSettings

Throws:

java.net.MalformedURLException - if the configured ServerUri is incorrect

java.net.URISyntaxException - if the configured ServerUri is incorrect

getUseHttps

public boolean getUseHttps()

Description copied from interface: IAnalyticsMonitorSettings

Get whether SSL is configured for the communication

Specified by:

getUseHttps in interface IAnalyticsMonitorSettings

Returns:

true if SSL is configured

getLocationCoordinates

public LocationCoordinates getLocationCoordinates()

Description copied from interface: IAnalyticsMonitorSettings

Get the location of the monitor as GPS coordinates. Use this property if you have access to GPS coordinates for the location of the application. If provided, these coordinates will be delivered to the servers as part of the data payload.

Specified by:

getLocationCoordinates in interface IAnalyticsMonitorSettings

Returns:

the LocationCoordinates