Package com.dynatrace.openkit.core.objects

Enum NullRootAction

java.lang.Object

java.lang.Enum<NullRootAction>

com.dynatrace.openkit.core.objects.NullRootAction

All Implemented Interfaces:

Action, RootAction, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, java.lang.Comparable<NullRootAction>

public enum NullRootAction
extends java.lang.Enum<NullRootAction>
implements RootAction

This implementation of RootAction is returned by Session.enterAction(String) when the Session.end()has been called before.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The sole NullRootAction instance

Method Summary

Modifier and Type	Method	Description
Action	cancelAction()	Cancels this Action.
void	close()
Action	enterAction(java.lang.String actionName)	Enters a (child) Action with a specified name on this Action.
long	getDurationInMilliseconds()	Get the action's duration in milliseconds.
Action	leaveAction()	Leaves this Action.
Action	reportError(java.lang.String errorName, int errorCode)	Reports an error with a specified name and error code.
Action	reportError(java.lang.String errorName, java.lang.String causeName, java.lang.String causeDescription, java.lang.String causeStackTrace)	Reports an error with a specified name and fields describing the cause of this error.
Action	reportError(java.lang.String errorName, java.lang.Throwable throwable)	Reports an error with a specified name and a Throwable.
Action	reportEvent(java.lang.String eventName)	Reports an event with a specified name (but without any value).
Action	reportValue(java.lang.String valueName, double value)	Reports a double value with a specified name.
Action	reportValue(java.lang.String valueName, int value)	Reports an int value with a specified name.
Action	reportValue(java.lang.String valueName, long value)	Reports a long value with a specified name.
Action	reportValue(java.lang.String valueName, java.lang.String value)	Reports a String value with a specified name.
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.
static NullRootAction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NullRootAction[]	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

INSTANCE

public static final NullRootAction INSTANCE

The sole NullRootAction instance

Method Detail

values

public static NullRootAction[] 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 (NullRootAction c : NullRootAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static NullRootAction 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

enterAction

public Action enterAction(java.lang.String actionName)

Description copied from interface: RootAction

Enters a (child) Action with a specified name on this Action.

If the given actionName is null or an empty string, no reporting will happen on that RootAction.

Specified by:

enterAction in interface RootAction

Parameters:

actionName - name of the Action

Returns:

Action instance to work with

reportEvent

public Action reportEvent(java.lang.String eventName)

Description copied from interface: Action

Reports an event with a specified name (but without any value).

If given eventName is null or an empty String then no event is reported to the system.

Specified by:

reportEvent in interface Action

Parameters:

eventName - name of the event

Returns:

this Action (for usage as fluent API)

reportValue

public Action reportValue(java.lang.String valueName,
                          int value)

Description copied from interface: Action

Reports an int value with a specified name.

If given valueName is null or an empty String then no event is reported to the system.

Specified by:

reportValue in interface Action

Parameters:

valueName - name of this value

value - value itself

Returns:

this Action (for usage as fluent API)

reportValue

public Action reportValue(java.lang.String valueName,
                          long value)

Description copied from interface: Action

Reports a long value with a specified name.

If given valueName is null or an empty String then no event is reported to the system.

Specified by:

reportValue in interface Action

Parameters:

valueName - name of this value

value - value itself

Returns:

this Action (for usage as fluent API)

reportValue

public Action reportValue(java.lang.String valueName,
                          double value)

Description copied from interface: Action

Reports a double value with a specified name.

If given valueName is null or an empty String then no event is reported to the system.

Specified by:

reportValue in interface Action

Parameters:

valueName - name of this value

value - value itself

Returns:

this Action (for usage as fluent API)

reportValue

public Action reportValue(java.lang.String valueName,
                          java.lang.String value)

Description copied from interface: Action

Reports a String value with a specified name.

If given valueName is null or an empty String then no event is reported to the system.

Specified by:

reportValue in interface Action

Parameters:

valueName - name of this value

value - value itself The value can be null or an empty String.

Returns:

this Action (for usage as fluent API)

reportError

public Action reportError(java.lang.String errorName,
                          int errorCode)

Description copied from interface: Action

Reports an error with a specified name and error code.

If given errorName is null or an empty String then no event is reported to the system.

Specified by:

reportError in interface Action

Parameters:

errorName - name of this error

errorCode - numeric error code of this error

Returns:

this Action (for usage as fluent API)

reportError

public Action reportError(java.lang.String errorName,
                          java.lang.String causeName,
                          java.lang.String causeDescription,
                          java.lang.String causeStackTrace)

Description copied from interface: Action

Reports an error with a specified name and fields describing the cause of this error.

If given errorName is null or an empty string then no event is reported to the system. If the causeDescription is longer than 1000 characters, it is truncated to this value. If the causeStackTrace is longer than 128.000 characters, it is truncated according to the last line break.

Specified by:

reportError in interface Action

Parameters:

errorName - name of this error

causeName - name describing the cause of the error. E.g. the class name of a caught exception.

causeDescription - description what caused the error E.g. Throwable.getMessage() of a caught exception.

causeStackTrace - stack trace of the error E.g. the Throwable stack trace

Returns:

this Action (for usage as fluent API)

reportError

public Action reportError(java.lang.String errorName,
                          java.lang.Throwable throwable)

Description copied from interface: Action

Reports an error with a specified name and a Throwable.

If given errorName is null or an empty string then no event is reported to the system.

Specified by:

reportError in interface Action

Parameters:

errorName - name of this error

throwable - Throwable causing this error

Returns:

this Action (for usage as fluent API)

traceWebRequest

public WebRequestTracer traceWebRequest(java.net.URLConnection connection)

Description copied from interface: Action

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.

If given connection is null then no event is reported to the system.

Specified by:

traceWebRequest in interface Action

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: Action

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.

If given url is null or an empty string then no event is reported to the system.

Specified by:

traceWebRequest in interface Action

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

leaveAction

public Action leaveAction()

Description copied from interface: Action

Leaves this Action.

Specified by:

leaveAction in interface Action

Returns:

the parent Action, or null if there is no parent Action

cancelAction

public Action cancelAction()

Description copied from interface: Action

Cancels this Action.

Canceling an action is similar to leaving an action, except that the data and all unfinished child objects are discarded instead of being sent.

Specified by:

cancelAction in interface Action

Returns:

the parent Action, or null if there is no parent Action

getDurationInMilliseconds

public long getDurationInMilliseconds()

Description copied from interface: Action

Get the action's duration in milliseconds.

The duration of an Action is equal to the current timestamp - start timestamp, if the action is still open, or end timestamp - start timestamp if Action.leaveAction() or Action.cancelAction() was already called.

Specified by:

getDurationInMilliseconds in interface Action

Returns:

The duration of this Action.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable