com.dynatrace.openkit.core.objects

Class OpenKitImpl

java.lang.Object

com.dynatrace.openkit.core.objects.OpenKitComposite

com.dynatrace.openkit.core.objects.OpenKitImpl

All Implemented Interfaces:

OpenKit, OpenKitObject, SessionCreatorInput, java.io.Closeable, java.lang.AutoCloseable

public class OpenKitImpl
extends OpenKitComposite
implements OpenKit, SessionCreatorInput

Actual implementation of the OpenKit interface.

Constructor Summary

Constructors

Constructor and Description
OpenKitImpl(OpenKitInitializer initializer) Public constructor for creating an OpenKit instance.

Method Summary

Modifier and Type	Method and Description
void	close()
Session	createSession() Creates a Session instance which can then be used to create Actions.
Session	createSession(java.lang.String clientIPAddress) Creates a Session instance which can then be used to create Actions.
BeaconCache	getBeaconCache() Returns the beacon cache in which new sessions/beacons will be stored until they are sent.
int	getCurrentServerId() Returns the current server ID.
Logger	getLogger() Returns the logger to report/trace messages.
OpenKitConfiguration	getOpenKitConfiguration() Returns the application / device related configuration
PrivacyConfiguration	getPrivacyConfiguration() Returns the privacy related configuration
SessionIDProvider	getSessionIdProvider() Returns the provider to obtain the next session ID
ThreadIDProvider	getThreadIdProvider() Returns the provider to obtain the ID of the current thread.
TimingProvider	getTimingProvider() Returns the provider to obtain the current timestamp.
void	initialize() Initialize this OpenKit instance.
boolean	isInitialized() Returns whether OpenKit is initialized or not.
void	shutdown() Shuts down OpenKit, ending all open Sessions and waiting for them to be sent.
boolean	waitForInitCompletion() Waits until OpenKit is fully initialized.
boolean	waitForInitCompletion(long timeoutMillis) Waits until OpenKit is fully initialized or the given timeout expired.

Methods inherited from class com.dynatrace.openkit.core.objects.OpenKitComposite

getActionID

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenKitImpl

public OpenKitImpl(OpenKitInitializer initializer)

Public constructor for creating an OpenKit instance.

Parameters:

initializer - provider to get all OpenKit related configuration parameters.

Method Detail

initialize

public void initialize()

Initialize this OpenKit instance.

This method starts the BeaconSender and is called directly after the instance has been created in AbstractOpenKitBuilder.

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

waitForInitCompletion

public boolean waitForInitCompletion()

Description copied from interface: OpenKit

Waits until OpenKit is fully initialized.

The calling thread is blocked until OpenKit is fully initialized or until OpenKit is shut down using the OpenKit.shutdown() method. Be aware, if AbstractOpenKitBuilder is wrongly configured, for example when creating an instance with an incorrect endpoint URL, then this method might hang indefinitely, unless OpenKit.shutdown() is called.

Specified by:

waitForInitCompletion in interface OpenKit

Returns:

true when OpenKit is fully initialized, false when a shutdown request was made.

waitForInitCompletion

public boolean waitForInitCompletion(long timeoutMillis)

Description copied from interface: OpenKit

Waits until OpenKit is fully initialized or the given timeout expired.

The calling thread is blocked until OpenKit is fully initialized or until OpenKit is shut down using the OpenKit.shutdown() method or the timeout expired..

Be aware, if AbstractOpenKitBuilder is wrongly configured, for example when creating an instance with an incorrect endpoint URL, then this method might hang indefinitely, unless OpenKit.shutdown() is called or timeout expires.

Specified by:

waitForInitCompletion in interface OpenKit

Parameters:

timeoutMillis - The maximum number of milliseconds to wait for initialization being completed.

Returns:

true when OpenKit is fully initialized, false when a shutdown request was made or timeoutMillis expired.

isInitialized

public boolean isInitialized()

Description copied from interface: OpenKit

Returns whether OpenKit is initialized or not.

Specified by:

isInitialized in interface OpenKit

Returns:

true if OpenKit is fully initialized, false if OpenKit still performs initialization.

createSession

public Session createSession(java.lang.String clientIPAddress)

Description copied from interface: OpenKit

Creates a Session instance which can then be used to create Actions.

Specified by:

createSession in interface OpenKit

Parameters:

clientIPAddress - client IP address where this Session is coming from

Returns:

Session instance to work with

createSession

public Session createSession()

Description copied from interface: OpenKit

Creates a Session instance which can then be used to create Actions.

This is similar to the method OpenKit.createSession(String), except that the client's IP address is determined on the server side.

Specified by:

createSession in interface OpenKit

Returns:

Session instance to work with

shutdown

public void shutdown()

Description copied from interface: OpenKit

Shuts down OpenKit, ending all open Sessions and waiting for them to be sent.

Specified by:

shutdown in interface OpenKit

getLogger

public Logger getLogger()

Description copied from interface: SessionCreatorInput

Returns the logger to report/trace messages.

Specified by:

getLogger in interface SessionCreatorInput

getOpenKitConfiguration

public OpenKitConfiguration getOpenKitConfiguration()

Description copied from interface: SessionCreatorInput

Returns the application / device related configuration

Specified by:

getOpenKitConfiguration in interface SessionCreatorInput

getPrivacyConfiguration

public PrivacyConfiguration getPrivacyConfiguration()

Description copied from interface: SessionCreatorInput

Returns the privacy related configuration

Specified by:

getPrivacyConfiguration in interface SessionCreatorInput

getBeaconCache

public BeaconCache getBeaconCache()

Description copied from interface: SessionCreatorInput

Returns the beacon cache in which new sessions/beacons will be stored until they are sent.

Specified by:

getBeaconCache in interface SessionCreatorInput

getSessionIdProvider

public SessionIDProvider getSessionIdProvider()

Description copied from interface: SessionCreatorInput

Returns the provider to obtain the next session ID

Specified by:

getSessionIdProvider in interface SessionCreatorInput

getThreadIdProvider

public ThreadIDProvider getThreadIdProvider()

Description copied from interface: SessionCreatorInput

Returns the provider to obtain the ID of the current thread.

Specified by:

getThreadIdProvider in interface SessionCreatorInput

getTimingProvider

public TimingProvider getTimingProvider()

Description copied from interface: SessionCreatorInput

Returns the provider to obtain the current timestamp.

Specified by:

getTimingProvider in interface SessionCreatorInput

getCurrentServerId

public int getCurrentServerId()

Description copied from interface: SessionCreatorInput

Returns the current server ID.

Specified by:

getCurrentServerId in interface SessionCreatorInput