Package com.dynatrace.openkit.core.objects

Enum NullWebRequestTracer

java.lang.Object

java.lang.Enum<NullWebRequestTracer>

com.dynatrace.openkit.core.objects.NullWebRequestTracer

All Implemented Interfaces:

WebRequestTracer, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, java.lang.Comparable<NullWebRequestTracer>

public enum NullWebRequestTracer
extends java.lang.Enum<NullWebRequestTracer>
implements WebRequestTracer

This implementation of WebRequestTracer is returned by Action.traceWebRequest(String) or Action.traceWebRequest(java.net.URLConnection) when the Action.leaveAction() ()} has been called before.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The sole NullWebRequestTracer instance

Method Summary

Modifier and Type	Method	Description
void	close()
java.lang.String	getTag()	Returns the Dynatrace tag which has to be set manually as Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER).
WebRequestTracer	setBytesReceived(int bytesReceived)	Sets the amount of received data of this web request.
WebRequestTracer	setBytesReceived(long bytesReceived)	Sets the amount of received data of this web request.
WebRequestTracer	setBytesSent(int bytesSent)	Sets the amount of sent data of this web request.
WebRequestTracer	setBytesSent(long bytesSent)	Sets the amount of sent data of this web request.
WebRequestTracer	start()	Starts the web request timing.
void	stop(int respondeCode)	Stops the web request timing with the given response code.
static NullWebRequestTracer	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NullWebRequestTracer[]	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 NullWebRequestTracer INSTANCE

The sole NullWebRequestTracer instance

Method Detail

values

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

Returns:

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

valueOf

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

getTag

public java.lang.String getTag()

Description copied from interface: WebRequestTracer

Returns the Dynatrace tag which has to be set manually as Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER).
This is only necessary for tracing web requests via 3rd party HTTP clients.

Specified by:

getTag in interface WebRequestTracer

Returns:

the Dynatrace tag to be set as HTTP header value or an empty String if capture is off

setBytesSent

public WebRequestTracer setBytesSent(int bytesSent)

Description copied from interface: WebRequestTracer

Sets the amount of sent data of this web request. Has to be called before WebRequestTracer.stop(int).

Specified by:

setBytesSent in interface WebRequestTracer

Parameters:

bytesSent - number of bytes

setBytesSent

public WebRequestTracer setBytesSent(long bytesSent)

Description copied from interface: WebRequestTracer

Sets the amount of sent data of this web request. Has to be called before WebRequestTracer.stop(int).

Specified by:

setBytesSent in interface WebRequestTracer

Parameters:

bytesSent - number of bytes

setBytesReceived

public WebRequestTracer setBytesReceived(int bytesReceived)

Description copied from interface: WebRequestTracer

Sets the amount of received data of this web request. Has to be called before WebRequestTracer.stop(int).

Specified by:

setBytesReceived in interface WebRequestTracer

Parameters:

bytesReceived - number of bytes

setBytesReceived

public WebRequestTracer setBytesReceived(long bytesReceived)

Description copied from interface: WebRequestTracer

Sets the amount of received data of this web request. Has to be called before WebRequestTracer.stop(int).

Specified by:

setBytesReceived in interface WebRequestTracer

Parameters:

bytesReceived - number of bytes

start

public WebRequestTracer start()

Description copied from interface: WebRequestTracer

Starts the web request timing. Should be called when the web request is initiated.

Specified by:

start in interface WebRequestTracer

stop

public void stop(int respondeCode)

Description copied from interface: WebRequestTracer

Stops the web request timing with the given response code. Should be called when the web request is finished.

Specified by:

stop in interface WebRequestTracer

Parameters:

respondeCode - response code of this web request

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable