com.dynatrace.openkit

Class AbstractOpenKitBuilder

java.lang.Object

com.dynatrace.openkit.AbstractOpenKitBuilder

Direct Known Subclasses:

AppMonOpenKitBuilder, DynatraceOpenKitBuilder

public abstract class AbstractOpenKitBuilder
extends java.lang.Object

Abstract base class for concrete builder. Using the builder a OpenKit instance can be created

Method Summary

Modifier and Type	Method and Description
OpenKit	build() Builds a new OpenKit instance
protected static long	deviceIdFromString(java.lang.String deviceId)
AbstractOpenKitBuilder	enableVerbose() Enables verbose mode.
AbstractOpenKitBuilder	withApplicationVersion(java.lang.String applicationVersion) Defines the version of the application.
AbstractOpenKitBuilder	withBeaconCacheLowerMemoryBoundary(long lowerMemoryBoundaryInBytes) Sets the lower memory boundary of the beacon cache.
AbstractOpenKitBuilder	withBeaconCacheMaxRecordAge(long maxRecordAgeInMilliseconds) Sets the maximum beacon record age of beacon data in cache.
AbstractOpenKitBuilder	withBeaconCacheUpperMemoryBoundary(long upperMemoryBoundaryInBytes) Sets the upper memory boundary of the beacon cache.
AbstractOpenKitBuilder	withCrashReportingLevel(CrashReportingLevel crashReportLevel) Sets the flag if crash reporting is enabled
AbstractOpenKitBuilder	withDataCollectionLevel(DataCollectionLevel dataCollectionLevel) Sets the data collection level.
AbstractOpenKitBuilder	withLogger(Logger logger) Sets the logger.
AbstractOpenKitBuilder	withManufacturer(java.lang.String manufacturer) Sets the manufacturer information.
AbstractOpenKitBuilder	withModelID(java.lang.String modelID) Sets the model id.
AbstractOpenKitBuilder	withOperatingSystem(java.lang.String operatingSystem) Sets the operating system information.
AbstractOpenKitBuilder	withTrustManager(SSLTrustManager trustManager) Sets the trust manager.

Methods inherited from class java.lang.Object

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

Method Detail

deviceIdFromString

protected static long deviceIdFromString(java.lang.String deviceId)

enableVerbose

public AbstractOpenKitBuilder enableVerbose()

Enables verbose mode. Verbose mode is only enabled if the the default logger is used. If a custom logger is provided by calling withLogger debug and info log output depends on the values returned by isDebugEnabled and isInfoEnabled.

Returns:

this

withLogger

public AbstractOpenKitBuilder withLogger(Logger logger)

Sets the logger. If no logger is set the default console logger is used. For the default logger verbose mode is enabled by calling enableVerbose.

Parameters:

logger - the logger

Returns:

this

withApplicationVersion

public AbstractOpenKitBuilder withApplicationVersion(java.lang.String applicationVersion)

Defines the version of the application. The value is only set if it is neither null nor empty.

Parameters:

applicationVersion - the application version

Returns:

this

withTrustManager

public AbstractOpenKitBuilder withTrustManager(SSLTrustManager trustManager)

Sets the trust manager. Overrides the default trust manager which is SSLStrictTrustmanager by default-

Parameters:

trustManager - trust manager implementation

Returns:

this

withOperatingSystem

public AbstractOpenKitBuilder withOperatingSystem(java.lang.String operatingSystem)

Sets the operating system information. The value is only set if it is neither null nor empty.

Parameters:

operatingSystem - the operating system

Returns:

this

withManufacturer

public AbstractOpenKitBuilder withManufacturer(java.lang.String manufacturer)

Sets the manufacturer information. The value is only set if it is neither null nor empty.

Parameters:

manufacturer - the manufacturer

Returns:

this

withModelID

public AbstractOpenKitBuilder withModelID(java.lang.String modelID)

Sets the model id. The value is only set if it is neither null nor empty.

Parameters:

modelID - the model id

Returns:

this

withBeaconCacheMaxRecordAge

public AbstractOpenKitBuilder withBeaconCacheMaxRecordAge(long maxRecordAgeInMilliseconds)

Sets the maximum beacon record age of beacon data in cache.

Parameters:

maxRecordAgeInMilliseconds - The maximum beacon record age in milliseconds, or unbounded if negative.

Returns:

this

withBeaconCacheLowerMemoryBoundary

public AbstractOpenKitBuilder withBeaconCacheLowerMemoryBoundary(long lowerMemoryBoundaryInBytes)

Sets the lower memory boundary of the beacon cache.

When this is set to a positive value the memory based eviction strategy clears the collected data, until the data size in the cache falls below the configured limit.

Parameters:

lowerMemoryBoundaryInBytes - The lower boundary of the beacon cache or negative if unlimited.

Returns:

this

withBeaconCacheUpperMemoryBoundary

public AbstractOpenKitBuilder withBeaconCacheUpperMemoryBoundary(long upperMemoryBoundaryInBytes)

Sets the upper memory boundary of the beacon cache.

When this is set to a positive value the memory based eviction strategy starts to clear data from the beacon cache when the cache size exceeds this setting.

Parameters:

upperMemoryBoundaryInBytes - The lower boundary of the beacon cache or negative if unlimited.

Returns:

this

withDataCollectionLevel

public AbstractOpenKitBuilder withDataCollectionLevel(DataCollectionLevel dataCollectionLevel)

Sets the data collection level.

Depending on the chosen level the amount and granularity of data sent is controlled. OFF (0) - no data collected PERFORMANCE (1) - only performance related data is collected USER_BEHAVIOR (2) - all available RUM data including performance related data is collected default value is OFF(0)

Parameters:

dataCollectionLevel - Data collection level to apply.

Returns:

this

withCrashReportingLevel

public AbstractOpenKitBuilder withCrashReportingLevel(CrashReportingLevel crashReportLevel)

Sets the flag if crash reporting is enabled

default value is false

Parameters:

crashReportLevel - Flag if crash reporting is enabled

Returns:

this

build

public OpenKit build()

Builds a new OpenKit instance

Returns:

retursn an OpenKit instance