AbstractOpenKitBuilder (openkit-java 2.0.2 API)

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

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`OpenKit`	`build()` Builds a new `OpenKit` instance
`protected static long`	`deviceIdFromString(java.lang.String deviceId)`
`AbstractOpenKitBuilder`	`enableVerbose()` Deprecated. `withLogLevel(LogLevel)`
`abstract java.lang.String`	`getApplicationID()` Get the application id for which the OpenKit reports data.
`abstract java.lang.String`	`getApplicationName()` Get the application name.
`java.lang.String`	`getApplicationVersion()` Get the application version that has been set with `withApplicationVersion(String)`.
`long`	`getBeaconCacheLowerMemoryBoundary()` Get the beacon cache lower memory boundary that has been set with `withBeaconCacheLowerMemoryBoundary(long)`.
`long`	`getBeaconCacheMaxRecordAge()` Get the maximum beacon cache record age that has been set with `withBeaconCacheMaxRecordAge(long)`.
`long`	`getBeaconCacheUpperMemoryBoundary()` Get the beacon cache upper memory boundary that has been set with `withBeaconCacheUpperMemoryBoundary(long)`.
`CrashReportingLevel`	`getCrashReportLevel()` Get crash reporting level that has been set with `withCrashReportingLevel(CrashReportingLevel)`.
`DataCollectionLevel`	`getDataCollectionLevel()` Get data collection level that has been set with `withDataCollectionLevel(DataCollectionLevel)`.
`abstract int`	`getDefaultServerID()` Get the default server ID to communicate with.
`long`	`getDeviceID()` Get this device identifier that has been set in the constructor.
`java.lang.String`	`getEndpointURL()` Get the endpoint URL that has been set in the constructor.
`Logger`	`getLogger()` Get `Logger` that has been set with `withLogger(Logger)`.
`java.lang.String`	`getManufacturer()` Get the manufacturer that has been set with `withManufacturer(String)`.
`java.lang.String`	`getModelID()` Get the model identifier that has been set with `withModelID(String)`.
`abstract java.lang.String`	`getOpenKitType()` Get a string identifying the OpenKit type that gets created by this builder.
`java.lang.String`	`getOperatingSystem()` Get the operating system that has been set with `withOperatingSystem(String)`.
`java.lang.String`	`getOrigDeviceID()` Returns the `device identifier` in the representation before it was hashed (in case the original device ID was a non numeric string).
`SSLTrustManager`	`getTrustManager()` Get the SSL trust manager that has been set with `withTrustManager(SSLTrustManager)`.
`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 `OFF (0)` - Crashes are not sent to the server `OPT_OUT_CRASHES (1)` - Crashes are not sent to the server `OPT_IN_CRASHES (2)` - Crashes are sent to the server Default value: `OPT_IN_CRASHES`
`AbstractOpenKitBuilder`	`withDataCollectionLevel(DataCollectionLevel dataCollectionLevel)` Sets the data collection level.
`AbstractOpenKitBuilder`	`withLogger(Logger logger)` Sets the logger.
`AbstractOpenKitBuilder`	`withLogLevel(LogLevel level)` Sets the default log level if the default logger is used.
`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
```
@Deprecated
public AbstractOpenKitBuilder enableVerbose()
```
    Deprecated. withLogLevel(LogLevel)
    
    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
  - withLogLevel
```
public AbstractOpenKitBuilder withLogLevel(LogLevel level)
```
    Sets the default log level if the default logger is used. If a custom logger is provided by calling withLogger(Logger), debug and info log output depends on the values returned by Logger.isDebugEnabled() and Logger.isInfoEnabled().
    
    Parameters:
    
    level - The logLevel for the custom logger
    
    Returns:
    
    AbstractOpenKitBuilder
  - 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: USER_BEHAVIOR
    
    Parameters:
    
    dataCollectionLevel - Data collection level to apply.
    
    Returns:
    
    this
  - withCrashReportingLevel
```
public AbstractOpenKitBuilder withCrashReportingLevel(CrashReportingLevel crashReportLevel)
```
    Sets the flag if crash reporting is enabled OFF (0) - Crashes are not sent to the server
    OPT_OUT_CRASHES (1) - Crashes are not sent to the server
    OPT_IN_CRASHES (2) - Crashes are sent to the server
    Default value: OPT_IN_CRASHES
    
    Parameters:
    
    crashReportLevel - Flag if crash reporting is enabled
    
    Returns:
    
    this
  - build
```
public OpenKit build()
```
    Builds a new OpenKit instance
    
    Returns:
    
    returns an OpenKit instance
  - getOpenKitType
```
public abstract java.lang.String getOpenKitType()
```
    Get a string identifying the OpenKit type that gets created by this builder.
    The only real purpose is for logging reasons.
    
    Returns:
    
    Some identification string identifying the OpenKit's type.
  - getApplicationID
```
public abstract java.lang.String getApplicationID()
```
    Get the application id for which the OpenKit reports data.
    
    Returns:
    
    Application id for which data will be reported.
  - getApplicationName
```
public abstract java.lang.String getApplicationName()
```
    Get the application name.
    It depends on the concrete builder whether the application name is configurable or not. In any case the derived classes have to return a string that is neither null nor empty.
    
    Returns:
    
    The application's name
  - getDefaultServerID
```
public abstract int getDefaultServerID()
```
    Get the default server ID to communicate with.
    Specific OpenKit builder implementors might return a different default server ID by overriding this method.
    
    Returns:
    
    Default server id to communicate with.
  - getApplicationVersion
```
public java.lang.String getApplicationVersion()
```
    Get the application version that has been set with withApplicationVersion(String).
    
    Returns:
    
    Previously set application version or OpenKitConstants.DEFAULT_APPLICATION_VERSION if none has been set.
  - getOperatingSystem
```
public java.lang.String getOperatingSystem()
```
    Get the operating system that has been set with withOperatingSystem(String).
    
    Returns:
    
    Previously set operating system or OpenKitConstants.DEFAULT_OPERATING_SYSTEM if none has been set.
  - getManufacturer
```
public java.lang.String getManufacturer()
```
    Get the manufacturer that has been set with withManufacturer(String).
    
    Returns:
    
    Previously set manufacturer or OpenKitConstants.DEFAULT_MANUFACTURER if none has been set.
  - getModelID
```
public java.lang.String getModelID()
```
    Get the model identifier that has been set with withModelID(String).
    
    Returns:
    
    Previously set model ID or OpenKitConstants.DEFAULT_MODEL_ID if none has been set.
  - getEndpointURL
```
public java.lang.String getEndpointURL()
```
    Get the endpoint URL that has been set in the constructor.
    The endpoint URL is used to send beacon data to.
    
    Returns:
    
    Endpoint URL that has been configured in constructor.
  - getDeviceID
```
public long getDeviceID()
```
    Get this device identifier that has been set in the constructor.
    The device identifier is a unique numeric value that identifies this device or installation. The user of the OpenKit library is responsible for providing a unique value per device/installation, which stays consistent per device/installation.
    
    Returns:
    
    Device identifier set in the constructor.
  - getOrigDeviceID
```
public java.lang.String getOrigDeviceID()
```
    Returns the device identifier in the representation before it was hashed (in case the original device ID was a non numeric string).
    
    Returns:
    
    Device identifier in the representation as it was originally passed to the constructor.
  - getTrustManager
```
public SSLTrustManager getTrustManager()
```
    Get the SSL trust manager that has been set with withTrustManager(SSLTrustManager).
    SSLTrustManager implementation are responsible for checking the X509 certificate chain and rejecting untrusted/invalid certificates. The default implementation rejects every untrusted/invalid (including self-signed) certificate.
    
    Returns:
    
    Previously set SSL trust manager or a default implementation.
  - getBeaconCacheMaxRecordAge
```
public long getBeaconCacheMaxRecordAge()
```
    Get the maximum beacon cache record age that has been set with withBeaconCacheMaxRecordAge(long).
    
    Returns:
    
    Previously set maximum beacon cache record age or ConfigurationDefaults.DEFAULT_MAX_RECORD_AGE_IN_MILLIS if none has been set.
  - getBeaconCacheLowerMemoryBoundary
```
public long getBeaconCacheLowerMemoryBoundary()
```
    Get the beacon cache lower memory boundary that has been set with withBeaconCacheLowerMemoryBoundary(long).
    
    Returns:
    
    Previously set lower memory boundary or ConfigurationDefaults.DEFAULT_LOWER_MEMORY_BOUNDARY_IN_BYTES if none has been set.
  - getBeaconCacheUpperMemoryBoundary
```
public long getBeaconCacheUpperMemoryBoundary()
```
    Get the beacon cache upper memory boundary that has been set with withBeaconCacheUpperMemoryBoundary(long).
    
    Returns:
    
    Previously set upper memory boundary or ConfigurationDefaults.DEFAULT_UPPER_MEMORY_BOUNDARY_IN_BYTES if none has been set.
  - getDataCollectionLevel
```
public DataCollectionLevel getDataCollectionLevel()
```
    Get data collection level that has been set with withDataCollectionLevel(DataCollectionLevel).
    
    Returns:
    
    Previously set data collection level or ConfigurationDefaults.DEFAULT_DATA_COLLECTION_LEVEL if nothing has been set.
  - getCrashReportLevel
```
public CrashReportingLevel getCrashReportLevel()
```
    Get crash reporting level that has been set with withCrashReportingLevel(CrashReportingLevel).
    
    Returns:
    
    Previously set crash reporting level or ConfigurationDefaults.DEFAULT_CRASH_REPORTING_LEVEL if nothing has been set.
  - getLogger
```
public Logger getLogger()
```
    Get Logger that has been set with withLogger(Logger).
    
    Returns:
    
    Previously set logger or DefaultLogger if none has been set.

Class AbstractOpenKitBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

deviceIdFromString

enableVerbose

withLogLevel

withLogger

withApplicationVersion

withTrustManager

withOperatingSystem

withManufacturer

withModelID

withBeaconCacheMaxRecordAge

withBeaconCacheLowerMemoryBoundary

withBeaconCacheUpperMemoryBoundary

withDataCollectionLevel

withCrashReportingLevel

build

getOpenKitType

getApplicationID

getApplicationName

getDefaultServerID

getApplicationVersion

getOperatingSystem

getManufacturer

getModelID

getEndpointURL

getDeviceID

getOrigDeviceID

getTrustManager

getBeaconCacheMaxRecordAge

getBeaconCacheLowerMemoryBoundary

getBeaconCacheUpperMemoryBoundary

getDataCollectionLevel

getCrashReportLevel

getLogger