com.dynatrace.openkit.core

Class SessionImpl

java.lang.Object

com.dynatrace.openkit.core.SessionImpl

All Implemented Interfaces:

Session, java.io.Closeable, java.lang.AutoCloseable

public class SessionImpl
extends java.lang.Object
implements Session

Actual implementation of the Session interface.

Method Summary

Modifier and Type	Method and Description
void	clearCapturedData() Clears data that has been captured so far.
void	close()
void	end() Ends this Session and marks it as ready for immediate sending.
RootAction	enterAction(java.lang.String actionName) Enters an Action with a specified name in this Session.
BeaconConfiguration	getBeaconConfiguration() Get the BeaconConfiguration
long	getEndTime()
void	identifyUser(java.lang.String userTag) Tags a session with the provided userTag.
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)
void	setBeaconConfiguration(BeaconConfiguration beaconConfiguration) Set the BeaconConfiguration
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.

Methods inherited from class java.lang.Object

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

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

sendBeacon

public StatusResponse sendBeacon(HTTPClientProvider clientProvider)

getEndTime

public long getEndTime()

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.

setBeaconConfiguration

public void setBeaconConfiguration(BeaconConfiguration beaconConfiguration)

Set the BeaconConfiguration

getBeaconConfiguration

public BeaconConfiguration getBeaconConfiguration()

Get the BeaconConfiguration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object