com.dynatrace.openkit.core.configuration

Class ServerConfiguration.Builder

java.lang.Object

com.dynatrace.openkit.core.configuration.ServerConfiguration.Builder

Enclosing class:

ServerConfiguration

public static final class ServerConfiguration.Builder
extends java.lang.Object

Builder class for creating a custom instance of ServerConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder(ResponseAttributes responseAttributes) Construct and initialize fields from given ResponseAttributes.
Builder(ServerConfiguration serverConfiguration) Construct and initialize fields from given ServerConfiguration.

Method Summary

Modifier and Type	Method and Description
ServerConfiguration	build() Build the ServerConfiguration and return the new instance.
ServerConfiguration.Builder	withBeaconSizeInBytes(int beaconSizeInBytes) Configures the beacon size in Bytes.
ServerConfiguration.Builder	withCapture(boolean captureState) Enables/disables capturing by setting ServerConfiguration.isCaptureEnabled() to the corresponding value.
ServerConfiguration.Builder	withCrashReporting(boolean crashReportingState) Enables/disables crash reporting by setting ServerConfiguration.isCrashReportingEnabled() to the corresponding value.
ServerConfiguration.Builder	withErrorReporting(boolean errorReportingState) Enables/disables error reporting by setting ServerConfiguration.isErrorReportingEnabled() to the corresponding value.
ServerConfiguration.Builder	withMaxEventsPerSession(int maxEventsPerSession) Configures the maximum number of events per session, after which the session gets split.
ServerConfiguration.Builder	withMaxSessionDurationInMilliseconds(int maxSessionDurationInMillis) Configures the maximum duration of a session, after which the session gets split.
ServerConfiguration.Builder	withMultiplicity(int multiplicity) Configures the multiplicity factor.
ServerConfiguration.Builder	withSendIntervalInMilliseconds(int sendIntervalInMilliseconds) Configure the send interval in milliseconds.
ServerConfiguration.Builder	withServerID(int serverID) Configures the server ID.
ServerConfiguration.Builder	withSessionTimeoutInMilliseconds(int sessionTimeoutInMilliseconds) Configures the idle timeout after which a session gets split.
ServerConfiguration.Builder	withTrafficControlPercentage(int trafficControlPercentage) Configures the traffic control/cost control percentage.
ServerConfiguration.Builder	withVisitStoreVersion(int visitStoreVersion) Configures the version of the visit store that should be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(ResponseAttributes responseAttributes)

Construct and initialize fields from given ResponseAttributes.

Parameters:

responseAttributes - the attributes received as a response from the server.

Builder

public Builder(ServerConfiguration serverConfiguration)

Construct and initialize fields from given ServerConfiguration.

Method Detail

withCapture

public ServerConfiguration.Builder withCapture(boolean captureState)

Enables/disables capturing by setting ServerConfiguration.isCaptureEnabled() to the corresponding value.

Returns:

this

withCrashReporting

public ServerConfiguration.Builder withCrashReporting(boolean crashReportingState)

Enables/disables crash reporting by setting ServerConfiguration.isCrashReportingEnabled() to the corresponding value.

Returns:

this

withErrorReporting

public ServerConfiguration.Builder withErrorReporting(boolean errorReportingState)

Enables/disables error reporting by setting ServerConfiguration.isErrorReportingEnabled() to the corresponding value.

Returns:

this

withServerID

public ServerConfiguration.Builder withServerID(int serverID)

Configures the server ID.

Parameters:

serverID - The server ID to communicate with.

Returns:

this

withBeaconSizeInBytes

public ServerConfiguration.Builder withBeaconSizeInBytes(int beaconSizeInBytes)

Configures the beacon size in Bytes.

Parameters:

beaconSizeInBytes - Maximum allowed beacon size in bytes.

Returns:

this

withMultiplicity

public ServerConfiguration.Builder withMultiplicity(int multiplicity)

Configures the multiplicity factor.

Parameters:

multiplicity - Multiplicity factor.

Returns:

this

withSendIntervalInMilliseconds

public ServerConfiguration.Builder withSendIntervalInMilliseconds(int sendIntervalInMilliseconds)

Configure the send interval in milliseconds.

Parameters:

sendIntervalInMilliseconds - Send interval in milliseconds

Returns:

this

withMaxSessionDurationInMilliseconds

public ServerConfiguration.Builder withMaxSessionDurationInMilliseconds(int maxSessionDurationInMillis)

Configures the maximum duration of a session, after which the session gets split.

Parameters:

maxSessionDurationInMillis - the maximum duration of a session in milliseconds

Returns:

this

withMaxEventsPerSession

public ServerConfiguration.Builder withMaxEventsPerSession(int maxEventsPerSession)

Configures the maximum number of events per session, after which the session gets split.

Parameters:

maxEventsPerSession - the maximum number of top level actions after which a session gets split.

Returns:

this

withSessionTimeoutInMilliseconds

public ServerConfiguration.Builder withSessionTimeoutInMilliseconds(int sessionTimeoutInMilliseconds)

Configures the idle timeout after which a session gets split.

Parameters:

sessionTimeoutInMilliseconds - the idle timeout in milliseconds after which a session gets split.

Returns:

this

withVisitStoreVersion

public ServerConfiguration.Builder withVisitStoreVersion(int visitStoreVersion)

Configures the version of the visit store that should be used.

Parameters:

visitStoreVersion - the version of the visit store to be used.

Returns:

this

withTrafficControlPercentage

public ServerConfiguration.Builder withTrafficControlPercentage(int trafficControlPercentage)

Configures the traffic control/cost control percentage.

This value is used as rate limit to limit the number of sessions being captured.

Parameters:

trafficControlPercentage - Percentage of sessions being captured.

Returns:

this

build

public ServerConfiguration build()

Build the ServerConfiguration and return the new instance.

Returns:

Newly created ServerConfiguration instance.