Package com.dynatrace.openkit.core.configuration

Class BeaconConfiguration

java.lang.Object

com.dynatrace.openkit.core.configuration.BeaconConfiguration

public class BeaconConfiguration
extends java.lang.Object

Configuration class storing all necessary data for a Beacon.

Method Summary

Modifier and Type	Method	Description
void	disableCapture()	Disables capturing and sets isServerConfigurationSet()
void	enableCapture()	Enables the capturing and sets isServerConfigurationSet()
static BeaconConfiguration	from(OpenKitConfiguration openKitConfiguration, PrivacyConfiguration privacyConfiguration, int serverId)	Create BeaconConfiguration from given OpenKitConfiguration and PrivacyConfiguration.
HTTPClientConfiguration	getHTTPClientConfiguration()	Get HTTP client configuration.
OpenKitConfiguration	getOpenKitConfiguration()	Get the OpenKit configuration object.
PrivacyConfiguration	getPrivacyConfiguration()	Get the OpenKit privacy configuration.
ServerConfiguration	getServerConfiguration()	Get server configuration that has been set before.
void	initializeServerConfiguration(ServerConfiguration initialServerConfiguration)	Initializes this beacon configuration with the given server configuration.
boolean	isServerConfigurationSet()	Get a boolean indicating whether the server configuration has been set before or not.
void	setServerConfigurationUpdateCallback(ServerConfigurationUpdateCallback updateCallback)	Sets the callback which will be invoked when the server configuration will be updated.
void	updateServerConfiguration(ServerConfiguration newServerConfiguration)	Update the ServerConfiguration object.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static BeaconConfiguration from(OpenKitConfiguration openKitConfiguration,
                                       PrivacyConfiguration privacyConfiguration,
                                       int serverId)

Create BeaconConfiguration from given OpenKitConfiguration and PrivacyConfiguration.

Parameters:

openKitConfiguration - OpenKit configuration

privacyConfiguration - Privacy settings configuration.

Returns:

null if any of the given argument is null, otherwise a new BeaconConfiguration.

getOpenKitConfiguration

public OpenKitConfiguration getOpenKitConfiguration()

Get the OpenKit configuration object.

Returns:

OpenKit related configuration.

getPrivacyConfiguration

public PrivacyConfiguration getPrivacyConfiguration()

Get the OpenKit privacy configuration.

Returns:

Privacy related configuration.

getServerConfiguration

public ServerConfiguration getServerConfiguration()

Get server configuration that has been set before.

If no server configuration has been set, use the default one.

Returns:

A ServerConfiguration object.

enableCapture

public void enableCapture()

Enables the capturing and sets isServerConfigurationSet()

disableCapture

public void disableCapture()

Disables capturing and sets isServerConfigurationSet()

initializeServerConfiguration

public void initializeServerConfiguration(ServerConfiguration initialServerConfiguration)

Initializes this beacon configuration with the given server configuration. This will not set isServerConfigurationSet() to true so that new session requests to the server will still be done. In case the isServerConfigurationSet() was already set, this method does nothing.

Parameters:

initialServerConfiguration - the server configuration to initialize this beacon configuration with.

updateServerConfiguration

public void updateServerConfiguration(ServerConfiguration newServerConfiguration)

Update the ServerConfiguration object.

If this is the first call to this method, use the configuration as is, otherwise merge the given configuration with the one already stored.

Parameters:

newServerConfiguration - New server configuration, as received from the server.

isServerConfigurationSet

public boolean isServerConfigurationSet()

Get a boolean indicating whether the server configuration has been set before or not.

Returns:

true if the ServerConfiguration has been set before, false otherwise.

setServerConfigurationUpdateCallback

public void setServerConfigurationUpdateCallback(ServerConfigurationUpdateCallback updateCallback)

Sets the callback which will be invoked when the server configuration will be updated.

Parameters:

updateCallback - the callback to be called on server configuration updates.

getHTTPClientConfiguration

public HTTPClientConfiguration getHTTPClientConfiguration()

Get HTTP client configuration.

Returns:

HTTP client configuration.