Package com.dynatrace.openkit.core.objects

Class SessionProxyImpl

java.lang.Object

com.dynatrace.openkit.core.objects.OpenKitComposite

com.dynatrace.openkit.core.objects.SessionProxyImpl

All Implemented Interfaces:

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

public class SessionProxyImpl
extends OpenKitComposite
implements Session, ServerConfigurationUpdateCallback

Implements a surrogate for a Session to perform session splitting after:

• a configured number of events
• after a configured idle timeout
• after a configured maximum session duration

Method Summary

Modifier and Type	Method	Description
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.
void	identifyUser(java.lang.String userTag)	Tags a session with the provided userTag.
boolean	isFinished()	Indicates whether this session proxy was finished or is still open.
void	onServerConfigurationUpdate(ServerConfiguration serverConfig)	Called when a server configuration is updated.
void	reportCarrier(java.lang.String carrier)	Reports the name of the cellular network carrier.
void	reportConnectionType(ConnectionType connectionType)	Reports the type of connection with which the device is connected to the network.
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.
void	reportCrash(java.lang.Throwable throwable)	Reports a crash with error name, crash reason and stacktrace determined from given Throwable.
void	reportNetworkTechnology(java.lang.String technology)	Reports the network technology in use (e.g.
void	sendBizEvent(java.lang.String type, java.util.Map<java.lang.String,JSONValue> attributes)	Send a Business Event With sendBizEvent, you can report a business event.
long	splitSessionByTime()	Will end the current active session and start a new one but only if the following conditions are met: this session proxy is not finished. session splitting by idle timeout is enabled and the current session was idle for longer than the configured timeout.
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 com.dynatrace.openkit.core.objects.OpenKitComposite

getActionID

Methods inherited from class java.lang.Object

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

Method Detail

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, this is equivalent to logging off the user.

The last non-empty userTag is re-applied to split sessions. Details are described in https://github.com/Dynatrace/openkit-java/blob/main/docs/internals.md#identify-users-on-split-sessions.

Specified by:

identifyUser in interface Session

Parameters:

userTag - id of the user or null/"" to simulate a log off.

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. If the reason is longer than 1000 characters, it is truncated to this value. If the stacktrace is longer than 128.000 characters, it is truncated according to the last line break.

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

reportCrash

public void reportCrash(java.lang.Throwable throwable)

Description copied from interface: Session

Reports a crash with error name, crash reason and stacktrace determined from given Throwable.

This method is offered as convenience method for Session.reportCrash(Throwable).

Specified by:

reportCrash in interface Session

Parameters:

throwable - The Throwable causing the crash.

reportNetworkTechnology

public void reportNetworkTechnology(java.lang.String technology)

Description copied from interface: Session

Reports the network technology in use (e.g. 2G, 3G, 802.11x, offline, ...) Use null to clear the value again and it will no longer be sent with the next beacon.

Specified by:

reportNetworkTechnology in interface Session

Parameters:

technology - the used network technology

reportConnectionType

public void reportConnectionType(ConnectionType connectionType)

Description copied from interface: Session

Reports the type of connection with which the device is connected to the network. Use null to clear the value again and it will no longer be sent with the next beacon.

Specified by:

reportConnectionType in interface Session

Parameters:

connectionType - the type of connection

reportCarrier

public void reportCarrier(java.lang.String carrier)

Description copied from interface: Session

Reports the name of the cellular network carrier. Use null to clear the value again and it will no longer be sent with the next beacon.

The given value will be truncated to 250 characters.

Specified by:

reportCarrier in interface Session

Parameters:

carrier - the cellular network carrier

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

sendBizEvent

public void sendBizEvent(java.lang.String type,
                         java.util.Map<java.lang.String,JSONValue> attributes)

Description copied from interface: Session

Send a Business Event With sendBizEvent, you can report a business event. These standalone events are being sent detached from user actions or sessions. Note: The 'dt' key, as well as all 'dt.' prefixed keys are considered reserved by Dynatrace and will be stripped from the passed in attributes. Note: Business events are only supported on Dynatrace SaaS deployments currently.

Specified by:

sendBizEvent in interface Session

Parameters:

type - Mandatory event type

attributes - Must be a valid JSON object. The resulting event will be populated with the 'attributes'-parameter and enriched with additional properties. Therefore, even empty objects are valid.

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

isFinished

public boolean isFinished()

Indicates whether this session proxy was finished or is still open.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

splitSessionByTime

public long splitSessionByTime()

Will end the current active session and start a new one but only if the following conditions are met:

• this session proxy is not finished.
• session splitting by idle timeout is enabled and the current session was idle for longer than the configured timeout.
• session splitting by maximum session duration is enabled and the session was open for longer than the maximum configured session duration.

Returns:

the time when the session might be split next. This can either be the time when the maximum session duration is reached or the time when the idle timeout expires. In case this session proxy is finished, -1 is returned.

onServerConfigurationUpdate

public void onServerConfigurationUpdate(ServerConfiguration serverConfig)

Description copied from interface: ServerConfigurationUpdateCallback

Called when a server configuration is updated.

Specified by:

onServerConfigurationUpdate in interface ServerConfigurationUpdateCallback

Parameters:

serverConfig - the updated server configuration.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object