eqatec.analytics.monitor

Interface IAnalyticsMonitorSettings

All Known Implementing Classes:

AnalyticsMonitorSettings

public interface IAnalyticsMonitorSettings

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

Method Detail

getProductId

java.util.UUID getProductId()

Gets the product id.

Returns:

the product id

setVersion

void setVersion(Version version)

Sets the version of the application

Parameters:

version - the new version

getVersion

Version getVersion()

Gets the registered version of the application.

Returns:

the version

setLoggingInterface

void setLoggingInterface(ILogAnalyticsMonitor loggingInterface)

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

Parameters:

loggingInterface - the new logging interface

See Also:

ILogAnalyticsMonitor

getLoggingInterface

ILogAnalyticsMonitor getLoggingInterface()

Gets the logging interface.

Returns:

the logging interface

See Also:

ILogAnalyticsMonitor

setStorageInterface

void setStorageInterface(IStorage storage)

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

Parameters:

storage - the new storage

See Also:

IStorage

getStorageInterface

IStorage getStorageInterface()

Gets the current storage implementation.

Returns:

the storage

setStorageSaveInterval

void setStorageSaveInterval(long storageSaveInterval)

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

Parameters:

storageSaveInterval - the new storage save interval in milliseconds

getStorageSaveInterval

long getStorageSaveInterval()

Gets the storage save interval in milliseconds.

Returns:

the storage save interval

setServerUri

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

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

Parameters:

serverUri - the new server uri

Throws:

java.net.MalformedURLException - the malformed url exception

java.net.URISyntaxException - the uRI syntax exception

getServerUri

java.net.URI getServerUri()

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

Returns:

the server uri

getSynchronizeAutomatically

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

Returns:

true if monitor is set to synchronize automatically

setSynchronizeAutomatically

void setSynchronizeAutomatically(boolean syncAutomatically)

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

Parameters:

syncAutomatically -

getDailyNetworkUtilizationInKB

int getDailyNetworkUtilizationInKB()

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.

Returns:

the limit for the network utilization

setDailyNetworkUtilizationInKB

void setDailyNetworkUtilizationInKB(int dailyUtilizationLimit)

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.

Parameters:

dailyUtilizationLimit -

getMaxStorageSizeInKB

int getMaxStorageSizeInKB()

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

Returns:

the limit of the storage in KB

setMaxStorageSizeInKB

void setMaxStorageSizeInKB(int storageLimit)

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

Parameters:

storageLimit -

setTestMode

void setTestMode(boolean testMode)

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

Parameters:

testMode - the new test mode

getTestMode

boolean getTestMode()

Gets the test mode.

Returns:

the test mode

setUseSsl

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

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

Parameters:

useSsl -

Throws:

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

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

getUseHttps

boolean getUseHttps()

Get whether SSL is configured for the communication

Returns:

true if SSL is configured

getLocationCoordinates

LocationCoordinates getLocationCoordinates()

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.

Returns:

the LocationCoordinates