SessionImpl (openkit-java 2.0.1 API)

java.lang.Object
- com.dynatrace.openkit.core.objects.OpenKitComposite
- - com.dynatrace.openkit.core.objects.SessionImpl

All Implemented Interfaces:

Session, OpenKitObject, java.io.Closeable, java.lang.AutoCloseable
```
public class SessionImpl
extends OpenKitComposite
implements Session
```
Actual implementation of the Session interface.

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_NEW_SESSION_REQUESTS
The maximum number of "new session requests" to send per session.

Fields
Modifier and Type	Field and Description
`static int`	`MAX_NEW_SESSION_REQUESTS` The maximum number of "new session requests" to send per session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canSendNewSessionRequest()` Indicates whether new session requests can be sent or not.
`void`	`clearCapturedData()` Clears data that has been captured so far.
`void`	`close()`
`void`	`decreaseNumRemainingSessionRequests()` Decreases the number of remaining new session requests.
`void`	`disableCapture()` Disables capturing for this session.
`void`	`enableCapture()` Enables capturing for this session.
`void`	`end()` Ends this Session and marks it as ready for immediate sending.
`void`	`end(boolean sendSessionEndEvent)`
`RootAction`	`enterAction(java.lang.String actionName)` Enters an Action with a specified name in this Session.
`long`	`getSplitByEventsGracePeriodEndTimeInMillis()` Returns the time when the session is to be ended (after it was not possible to end the session after splitting events e.g.
`SessionState`	`getState()`
`void`	`identifyUser(java.lang.String userTag)` Tags a session with the provided `userTag`.
`void`	`initializeServerConfiguration(ServerConfiguration initialServerConfig)` Initializes the `Beacon` with the given `ServerConfiguration`
`boolean`	`isDataSendingAllowed()` Indicates whether sending data for this session is allowed or not.
`boolean`	`isEmpty()` Test if this Session is empty or not.
`void`	`reportCrash(java.lang.String errorName, java.lang.String reason, java.lang.String stacktrace)` Reports a crash with a specified error name, crash reason and a stacktrace.
`StatusResponse`	`sendBeacon(HTTPClientProvider clientProvider, AdditionalQueryParameters additionalParameters)` Sends the current beacon state.
`void`	`setSplitByEventsGracePeriodEndTimeInMillis(long endTime)` Sets the end time when the session is to be actually ended after a session split by event count.
`java.lang.String`	`toString()`
`WebRequestTracer`	`traceWebRequest(java.lang.String url)` Allows tracing and timing of a web request handled by any 3rd party HTTP Client (e.g.
`WebRequestTracer`	`traceWebRequest(java.net.URLConnection connection)` Traces a web request - which is provided as a URLConnection - and allows adding timing information to this request.
`boolean`	`tryEnd()` Tries to end the current session by checking if there are no more child objects (actions / web request tracers) open.
`void`	`updateServerConfiguration(ServerConfiguration serverConfiguration)` Update the `Beacon` with the given `ServerConfiguration`

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, wait, wait, wait

- Field Detail
  - MAX_NEW_SESSION_REQUESTS
```
public static final int MAX_NEW_SESSION_REQUESTS
```
    The maximum number of "new session requests" to send per session.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - enterAction
```
public RootAction enterAction(java.lang.String actionName)
```
    Description copied from interface: Session
    
    Enters an Action with a specified name in this Session.
    If the given actionName is null or an empty string, no reporting will happen on that RootAction.
    
    Specified by:
    
    enterAction in interface Session
    
    Parameters:
    
    actionName - name of the Action
    
    Returns:
    
    Action instance to work with
  - identifyUser
```
public void identifyUser(java.lang.String userTag)
```
    Description copied from interface: Session
    
    Tags a session with the provided userTag.
    If the given userTag is null or an empty string, no user identification will be reported to the server.
    
    Specified by:
    
    identifyUser in interface Session
    
    Parameters:
    
    userTag - id of the user
  - reportCrash
```
public void reportCrash(java.lang.String errorName,
                        java.lang.String reason,
                        java.lang.String stacktrace)
```
    Description copied from interface: Session
    
    Reports a crash with a specified error name, crash reason and a stacktrace.
    If the given errorName is null or an empty string, no crash report will be sent to the server.
    
    Specified by:
    
    reportCrash in interface Session
    
    Parameters:
    
    errorName - name of the error leading to the crash (e.g. Exception class)
    
    reason - reason or description of that error
    
    stacktrace - stacktrace leading to that crash
  - traceWebRequest
```
public WebRequestTracer traceWebRequest(java.net.URLConnection connection)
```
    Description copied from interface: Session
    
    Traces a web request - which is provided as a URLConnection - and allows adding timing information to this request. If the web request is continued on a server-side Agent (e.g. Java, .NET, ...) this Session will be correlated to the resulting server-side PurePath.
    
    Specified by:
    
    traceWebRequest in interface Session
    
    Parameters:
    
    connection - the URLConnection of the HTTP request to be tagged and timed
    
    Returns:
    
    a WebRequestTracer which allows adding timing information
  - traceWebRequest
```
public WebRequestTracer traceWebRequest(java.lang.String url)
```
    Description copied from interface: Session
    
    Allows tracing and timing of a web request handled by any 3rd party HTTP Client (e.g. Apache, Google, Jetty, ...). In this case the Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER) has to be set manually to the tag value of this WebRequestTracer.
    If the web request is continued on a server-side Agent (e.g. Java, .NET, ...) this Session will be correlated to the resulting server-side PurePath.
    
    Specified by:
    
    traceWebRequest in interface Session
    
    Parameters:
    
    url - the URL of the web request to be tagged and timed
    
    Returns:
    
    a WebRequestTracer which allows getting the tag value and adding timing information
  - end
```
public void end()
```
    Description copied from interface: Session
    
    Ends this Session and marks it as ready for immediate sending.
    
    Specified by:
    
    end in interface Session
  - end
```
public void end(boolean sendSessionEndEvent)
```
  - tryEnd
```
public boolean tryEnd()
```
    Tries to end the current session by checking if there are no more child objects (actions / web request tracers) open. In case no more child objects are open the session is ended otherwise it is kept open.
    
    Returns:
    
    true if the session was successfully ended (or was already ended before). false in case there are / were still open child objects (actions / web request tracers).
  - setSplitByEventsGracePeriodEndTimeInMillis
```
public void setSplitByEventsGracePeriodEndTimeInMillis(long endTime)
```
    Sets the end time when the session is to be actually ended after a session split by event count. It might occur that a session is not yet ready to be finished (e.g. open actions, tracers) when the session split happens. In this case the session is kept open and closed at a later time. The given end time is the point in time at which the session will be closed forcefully by the SessionWatchdog thread.
    
    Parameters:
    
    endTime - the time when the session is to be closed for good.
  - getSplitByEventsGracePeriodEndTimeInMillis
```
public long getSplitByEventsGracePeriodEndTimeInMillis()
```
    Returns the time when the session is to be ended (after it was not possible to end the session after splitting events e.g. due to actions still being open). The returned time already includes a grace period.
  - sendBeacon
```
public StatusResponse sendBeacon(HTTPClientProvider clientProvider,
                                 AdditionalQueryParameters additionalParameters)
```
    Sends the current beacon state.
    
    Parameters:
    
    clientProvider - Provider class providing the client for data transmission.
    
    additionalParameters - additional parameters that will be appended to the beacon request (can be null).
    
    Returns:
    
    Response from client.
  - clearCapturedData
```
public void clearCapturedData()
```
    Clears data that has been captured so far.
    This is called, when capturing is turned off to avoid having too much data.
  - isEmpty
```
public boolean isEmpty()
```
    Test if this Session is empty or not.
    A session is considered to be empty, if it does not contain any action or event data.
    
    Returns:
    
    true if the session is empty, false otherwise.
  - initializeServerConfiguration
```
public void initializeServerConfiguration(ServerConfiguration initialServerConfig)
```
    Initializes the Beacon with the given ServerConfiguration
  - updateServerConfiguration
```
public void updateServerConfiguration(ServerConfiguration serverConfiguration)
```
    Update the Beacon with the given ServerConfiguration
  - getState
```
public SessionState getState()
```
  - isDataSendingAllowed
```
public boolean isDataSendingAllowed()
```
    Indicates whether sending data for this session is allowed or not.
  - enableCapture
```
public void enableCapture()
```
    Enables capturing for this session.
    Will implicitly also set the session state to configured.
  - disableCapture
```
public void disableCapture()
```
    Disables capturing for this session.
    Will implicitly also set the session state to configured.
  - canSendNewSessionRequest
```
public boolean canSendNewSessionRequest()
```
    Indicates whether new session requests can be sent or not.
    This is directly related to decreaseNumRemainingSessionRequests().
  - decreaseNumRemainingSessionRequests
```
public void decreaseNumRemainingSessionRequests()
```
    Decreases the number of remaining new session requests.
    In case no more new session requests remain, canSendNewSessionRequest() will return false
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SessionImpl

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

MAX_NEW_SESSION_REQUESTS

Method Detail

close

enterAction

identifyUser

reportCrash

traceWebRequest

traceWebRequest

end

end

tryEnd

setSplitByEventsGracePeriodEndTimeInMillis

getSplitByEventsGracePeriodEndTimeInMillis

sendBeacon

clearCapturedData

isEmpty

initializeServerConfiguration

updateServerConfiguration

getState

isDataSendingAllowed

enableCapture

disableCapture

canSendNewSessionRequest

decreaseNumRemainingSessionRequests

toString