com.dynatrace.openkit.protocol

Enum ResponseAttributesDefaults

java.lang.Object

java.lang.Enum<ResponseAttributesDefaults>

com.dynatrace.openkit.protocol.ResponseAttributesDefaults

All Implemented Interfaces:

ResponseAttributes, java.io.Serializable, java.lang.Comparable<ResponseAttributesDefaults>

public enum ResponseAttributesDefaults
extends java.lang.Enum<ResponseAttributesDefaults>
implements ResponseAttributes

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON_RESPONSE
KEY_VALUE_RESPONSE
UNDEFINED

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationId() Returns the ID of the application to which this configuration applies.
abstract int	getMaxBeaconSizeInBytes() Returns the maximum POST body size when sending beacons.
abstract int	getMaxEventsPerSession() Returns the maximum number of top level actions after which a session will be split.
abstract int	getMaxSessionDurationInMilliseconds() Returns the maximum duration of a session in milliseconds after which a session will be split.
int	getMultiplicity() Returns the multiplicity
int	getSendIntervalInMilliseconds() Returns the send interval in milliseconds.
int	getServerId() Returns the ID of the server to where all data should be sent.
abstract int	getSessionTimeoutInMilliseconds() Returns the idle timeout in milliseconds after which a session will be split.
java.lang.String	getStatus() Returns the status of the new session configuration request.
long	getTimestampInMilliseconds() Returns the timestamp of these attributes which were returned from the server.
int	getTrafficControlPercentage() Gets a session sampling in percent.
int	getVisitStoreVersion() Returns the version of the visit store to be used.
boolean	isAttributeSet(ResponseAttribute attribute) Checks whether the given attribute was set / sent from the server with this server response.
boolean	isCapture() Indicator whether capturing data is generally allowed or not.
boolean	isCaptureCrashes() Indicator whether crashes should be captured or not.
boolean	isCaptureErrors() Indicator whether errors should be captured or not.
ResponseAttributes	merge(ResponseAttributes responseAttributes) Creates a new response attributes object by merging the given response into this one.
static ResponseAttributesDefaults	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ResponseAttributesDefaults[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JSON_RESPONSE

public static final ResponseAttributesDefaults JSON_RESPONSE

KEY_VALUE_RESPONSE

public static final ResponseAttributesDefaults KEY_VALUE_RESPONSE

UNDEFINED

public static final ResponseAttributesDefaults UNDEFINED

Method Detail

values

public static ResponseAttributesDefaults[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResponseAttributesDefaults c : ResponseAttributesDefaults.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResponseAttributesDefaults valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getMaxBeaconSizeInBytes

public abstract int getMaxBeaconSizeInBytes()

Description copied from interface: ResponseAttributes

Returns the maximum POST body size when sending beacons.

Specified by:

getMaxBeaconSizeInBytes in interface ResponseAttributes

getMaxSessionDurationInMilliseconds

public abstract int getMaxSessionDurationInMilliseconds()

Description copied from interface: ResponseAttributes

Returns the maximum duration of a session in milliseconds after which a session will be split.

Specified by:

getMaxSessionDurationInMilliseconds in interface ResponseAttributes

getMaxEventsPerSession

public abstract int getMaxEventsPerSession()

Description copied from interface: ResponseAttributes

Returns the maximum number of top level actions after which a session will be split.

Specified by:

getMaxEventsPerSession in interface ResponseAttributes

getSessionTimeoutInMilliseconds

public abstract int getSessionTimeoutInMilliseconds()

Description copied from interface: ResponseAttributes

Returns the idle timeout in milliseconds after which a session will be split.

Specified by:

getSessionTimeoutInMilliseconds in interface ResponseAttributes

getSendIntervalInMilliseconds

public int getSendIntervalInMilliseconds()

Description copied from interface: ResponseAttributes

Returns the send interval in milliseconds.

Specified by:

getSendIntervalInMilliseconds in interface ResponseAttributes

getVisitStoreVersion

public int getVisitStoreVersion()

Description copied from interface: ResponseAttributes

Returns the version of the visit store to be used.

Specified by:

getVisitStoreVersion in interface ResponseAttributes

isCapture

public boolean isCapture()

Description copied from interface: ResponseAttributes

Indicator whether capturing data is generally allowed or not.

Specified by:

isCapture in interface ResponseAttributes

isCaptureCrashes

public boolean isCaptureCrashes()

Description copied from interface: ResponseAttributes

Indicator whether crashes should be captured or not.

Specified by:

isCaptureCrashes in interface ResponseAttributes

isCaptureErrors

public boolean isCaptureErrors()

Description copied from interface: ResponseAttributes

Indicator whether errors should be captured or not.

Specified by:

isCaptureErrors in interface ResponseAttributes

getTrafficControlPercentage

public int getTrafficControlPercentage()

Description copied from interface: ResponseAttributes

Gets a session sampling in percent.

Value returned here is configured per application as Cost Control.

Specified by:

getTrafficControlPercentage in interface ResponseAttributes

Returns:

traffic control/cost control percentage in range [1, 100].

getApplicationId

public java.lang.String getApplicationId()

Description copied from interface: ResponseAttributes

Returns the ID of the application to which this configuration applies.

This is sent by the JSON configuration only, as sanity check to fix a weird Jetty bug.

Specified by:

getApplicationId in interface ResponseAttributes

getMultiplicity

public int getMultiplicity()

Description copied from interface: ResponseAttributes

Returns the multiplicity

Specified by:

getMultiplicity in interface ResponseAttributes

getServerId

public int getServerId()

Description copied from interface: ResponseAttributes

Returns the ID of the server to where all data should be sent.

Specified by:

getServerId in interface ResponseAttributes

getStatus

public java.lang.String getStatus()

Description copied from interface: ResponseAttributes

Returns the status of the new session configuration request.

Specified by:

getStatus in interface ResponseAttributes

getTimestampInMilliseconds

public long getTimestampInMilliseconds()

Description copied from interface: ResponseAttributes

Returns the timestamp of these attributes which were returned from the server.

The timestamp is the duration from January, 1st, 1970

Specified by:

getTimestampInMilliseconds in interface ResponseAttributes

isAttributeSet

public boolean isAttributeSet(ResponseAttribute attribute)

Description copied from interface: ResponseAttributes

Checks whether the given attribute was set / sent from the server with this server response.

Specified by:

isAttributeSet in interface ResponseAttributes

Parameters:

attribute - the attribute to be checked if it was sent by the server.

Returns:

true if the given attribute was sent from the server with this attributes, false otherwise.

merge

public ResponseAttributes merge(ResponseAttributes responseAttributes)

Description copied from interface: ResponseAttributes

Creates a new response attributes object by merging the given response into this one. Single attributes are selectively taken over from the given attributes as long as the respective attribute is set.

Specified by:

merge in interface ResponseAttributes

Parameters:

responseAttributes - the response attributes which will be merged together with this one into a new response attributes object.

Returns:

a new response attributes instance by merging the given attributes with this attributes.