Package com.dynatrace.openkit.protocol
Interface ResponseAttributes
-
- All Known Implementing Classes:
ResponseAttributesDefaults,ResponseAttributesImpl
public interface ResponseAttributesDefines a response received from the server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetApplicationId()Returns the ID of the application to which this configuration applies.intgetMaxBeaconSizeInBytes()Returns the maximum POST body size when sending beacons.intgetMaxEventsPerSession()Returns the maximum number of top level actions after which a session will be split.intgetMaxSessionDurationInMilliseconds()Returns the maximum duration of a session in milliseconds after which a session will be split.intgetMultiplicity()Returns the multiplicityintgetSendIntervalInMilliseconds()Returns the send interval in milliseconds.intgetServerId()Returns the ID of the server to where all data should be sent.intgetSessionTimeoutInMilliseconds()Returns the idle timeout in milliseconds after which a session will be split.java.lang.StringgetStatus()Returns the status of the new session configuration request.longgetTimestampInMilliseconds()Returns the timestamp of these attributes which were returned from the server.intgetTrafficControlPercentage()Gets a session sampling in percent.intgetVisitStoreVersion()Returns the version of the visit store to be used.booleanisAttributeSet(ResponseAttribute attribute)Checks whether the given attribute was set / sent from the server with this server response.booleanisCapture()Indicator whether capturing data is generally allowed or not.booleanisCaptureCrashes()Indicator whether crashes should be captured or not.booleanisCaptureErrors()Indicator whether errors should be captured or not.ResponseAttributesmerge(ResponseAttributes responseAttributes)Creates a new response attributes object by merging the given response into this one.
-
-
-
Method Detail
-
getMaxBeaconSizeInBytes
int getMaxBeaconSizeInBytes()
Returns the maximum POST body size when sending beacons.
-
getMaxSessionDurationInMilliseconds
int getMaxSessionDurationInMilliseconds()
Returns the maximum duration of a session in milliseconds after which a session will be split.
-
getMaxEventsPerSession
int getMaxEventsPerSession()
Returns the maximum number of top level actions after which a session will be split.
-
getSessionTimeoutInMilliseconds
int getSessionTimeoutInMilliseconds()
Returns the idle timeout in milliseconds after which a session will be split.
-
getSendIntervalInMilliseconds
int getSendIntervalInMilliseconds()
Returns the send interval in milliseconds.
-
getVisitStoreVersion
int getVisitStoreVersion()
Returns the version of the visit store to be used.
-
isCapture
boolean isCapture()
Indicator whether capturing data is generally allowed or not.
-
isCaptureCrashes
boolean isCaptureCrashes()
Indicator whether crashes should be captured or not.
-
isCaptureErrors
boolean isCaptureErrors()
Indicator whether errors should be captured or not.
-
getTrafficControlPercentage
int getTrafficControlPercentage()
Gets a session sampling in percent.Value returned here is configured per application as Cost Control.
- Returns:
- traffic control/cost control percentage in range [1, 100].
-
getApplicationId
java.lang.String getApplicationId()
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.
-
getMultiplicity
int getMultiplicity()
Returns the multiplicity
-
getServerId
int getServerId()
Returns the ID of the server to where all data should be sent.
-
getStatus
java.lang.String getStatus()
Returns the status of the new session configuration request.
-
getTimestampInMilliseconds
long getTimestampInMilliseconds()
Returns the timestamp of these attributes which were returned from the server.The timestamp is the duration from January, 1st, 1970
-
isAttributeSet
boolean isAttributeSet(ResponseAttribute attribute)
Checks whether the given attribute was set / sent from the server with this server response.- Parameters:
attribute- the attribute to be checked if it was sent by the server.- Returns:
trueif the given attribute was sent from the server with this attributes,falseotherwise.
-
merge
ResponseAttributes merge(ResponseAttributes 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 attributeis set.- 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.
-
-