com.appdynamics.iot

Interface HttpRequestTracker

public interface HttpRequestTracker

Convenient interface to collect a NetworkRequestEvent with AppDynamics Business Transaction Correlation

Usage

Suppose that you have a method like this for making HTTP requests:

     public byte[] sendRequest(URL url) throws HttpException {
          try {
              // implementation omitted
              return responseBody;
          } catch (UnderlyingException e) {
              throw new HttpException(e);
          }
     }
 

Here's how you would augment this method to report requests to the SDK:

     public byte[] sendRequest(URL url) throws HttpException {
         HttpRequestTracker tracker = Instrumentation.beginHttpRequest(url);
         try {
              // implementation omitted
              tracker.withResponseCode(theResponseCode)
                     .withResponseHeaderFields(theResponseHeaderFields)
                     .reportDone();
              return responseBody;
         } catch (UnderlyingException e) {
              tracker.withThrowable(e)
                     .reportDone();
              throw new HttpException(e);
         }
     }
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Gets the error message associated with this request.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaderFields() Returns the request header fields associated with this request.
int	getResponseCode() Gets the HTTP status code associated with this request.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaderFields() Returns the response header fields associated with this request.
java.lang.Throwable	getThrowable() Gets the throwable associated with this request.
void	reportDone() Stops tracking an HTTP request.
HttpRequestTracker	withError(java.lang.String error) Indicates that this request encountered an error.
HttpRequestTracker	withRequestHeaderFields(java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestHeaderFields) Sets the request headers associated with this request.
HttpRequestTracker	withResponseCode(int responseCode) Sets the HTTP response code associated with this request.
HttpRequestTracker	withResponseHeaderFields(java.util.Map<java.lang.String,java.util.List<java.lang.String>> responseHeaderFields) Sets the response headers associated with this request.
HttpRequestTracker	withStatusLine(java.lang.String statusLine) Sets the HTTP status line associated with this request.
HttpRequestTracker	withThrowable(java.lang.Throwable throwable) Indicates that this request encountered an error.

Method Detail

getThrowable

java.lang.Throwable getThrowable()

Gets the throwable associated with this request.

Returns:

an throwable describing the error.

withThrowable

HttpRequestTracker withThrowable(java.lang.Throwable throwable)

Indicates that this request encountered an error. This method is preferred over withError(String). If both an error and an throwable are specified, the error is ignored.

Parameters:

throwable - A throwable describing the error.

Returns:

current HttpRequestTracker Object

getError

java.lang.String getError()

Gets the error message associated with this request.

Returns:

a String describing the error.

withError

HttpRequestTracker withError(java.lang.String error)

Indicates that this request encountered an error.

Parameters:

error - A string describing the error.

Returns:

current HttpRequestTracker Object

getResponseCode

int getResponseCode()

Gets the HTTP status code associated with this request.

Returns:

the status code of the response.

Throws:

java.lang.NullPointerException - if withResponseCode(int) has never been called to set the value.

withResponseCode

HttpRequestTracker withResponseCode(int responseCode)

Sets the HTTP response code associated with this request. If a response was received, this method must be called, or the request will not be reported.

Parameters:

responseCode - The status code of the response.

Returns:

current HttpRequestTracker Object

withStatusLine

HttpRequestTracker withStatusLine(java.lang.String statusLine)

Sets the HTTP status line associated with this request. This is optional

Parameters:

statusLine - Http Status

Returns:

current HttpRequestTracker Object

getResponseHeaderFields

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaderFields()

Returns the response header fields associated with this request.

Returns:

the headers of the request.

withResponseHeaderFields

HttpRequestTracker withResponseHeaderFields(java.util.Map<java.lang.String,java.util.List<java.lang.String>> responseHeaderFields)

Sets the response headers associated with this request.

Parameters:

responseHeaderFields - The headers of the response.

Returns:

current HttpRequestTracker Object

getRequestHeaderFields

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaderFields()

Returns the request header fields associated with this request.

Returns:

the headers of the request.

withRequestHeaderFields

HttpRequestTracker withRequestHeaderFields(java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestHeaderFields)

Sets the request headers associated with this request.

Parameters:

requestHeaderFields - The headers of the request.

Returns:

current HttpRequestTracker Object

reportDone

void reportDone()

Stops tracking an HTTP request. Adds the NetworkBeacon to the Beacon Buffer Immediately after receiving a response or an error, set the appropriate fields and call this method to report the outcome of the HTTP request. You should not continue to use this object after calling this method -- if you need to track another request, obtain a new instance.