com.dynatrace.openkit.core.objects

Class BaseActionImpl

java.lang.Object

com.dynatrace.openkit.core.objects.OpenKitComposite

com.dynatrace.openkit.core.objects.BaseActionImpl

All Implemented Interfaces:

Action, CancelableOpenKitObject, OpenKitObject, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

LeafActionImpl, RootActionImpl

public abstract class BaseActionImpl
extends OpenKitComposite
implements CancelableOpenKitObject, Action

Abstract base class implementing the Action interface.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the OpenKitObject.
Action	cancelAction() Cancels this Action.
void	close()
int	getActionID() Get the action id of this composite or 0 if the composite is not an action.
long	getDurationInMilliseconds() Get the action's duration in milliseconds.
int	getEndSequenceNo()
long	getEndTime()
int	getID()
java.lang.String	getName()
protected abstract Action	getParentAction() Get the parent Action, which might be null in case the parent does not implement Action.
int	getParentID()
int	getStartSequenceNo()
long	getStartTime()
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, int errorCode, java.lang.String reason) Deprecated.
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.

Methods inherited from class java.lang.Object

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

Method Detail

cancel

public void cancel()

Description copied from interface: CancelableOpenKitObject

Cancel the OpenKitObject.

Canceling is similar to closing, except that data that is not reported yet, will not be reported at all.

Specified by:

cancel in interface CancelableOpenKitObject

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

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

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

Deprecated.

Description copied from interface: Action

Reports an error with a specified name, error code and reason.

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

reason - reason for this error

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.

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.

getParentAction

protected abstract Action getParentAction()

Get the parent Action, which might be null in case the parent does not implement Action.

Returns:

The parent action object, or null if parent does not implement Action.

getActionID

public int getActionID()

Description copied from class: OpenKitComposite

Get the action id of this composite or 0 if the composite is not an action.

The default return value of 0 is implemented here. Action related composites need to override this method and return the appropriate value.

Overrides:

getActionID in class OpenKitComposite

Returns:

The action id of this composite.

getID

public int getID()

getName

public java.lang.String getName()

getParentID

public int getParentID()

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getStartSequenceNo

public int getStartSequenceNo()

getEndSequenceNo

public int getEndSequenceNo()