Package com.dynatrace.openkit.core.objects

Class WebRequestTracerBaseImpl

java.lang.Object

com.dynatrace.openkit.core.objects.WebRequestTracerBaseImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

WebRequestTracerStringURL, WebRequestTracerURLConnection

public abstract class WebRequestTracerBaseImpl
extends java.lang.Object
implements WebRequestTracer, CancelableOpenKitObject

Abstract base class implementation of the WebRequestTracer interface.

This class is guaranteed to be thread safe.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the OpenKitObject.
void	close()
long	getBytesReceived()
long	getBytesSent()
int	getEndSequenceNo()
long	getEndTime()
int	getResponseCode()
int	getStartSequenceNo()
long	getStartTime()
java.lang.String	getTag()	Returns the Dynatrace tag which has to be set manually as Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER).
java.lang.String	getURL()
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 responseCode)	Stops the web request timing with the given response code.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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 responseCode)

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:

responseCode - response code of this web request

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.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

getURL

public java.lang.String getURL()

getResponseCode

public int getResponseCode()

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getStartSequenceNo

public int getStartSequenceNo()

getEndSequenceNo

public int getEndSequenceNo()

getBytesSent

public long getBytesSent()

getBytesReceived

public long getBytesReceived()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object