com.browsermob.api
Interface TransactionStepObject

public interface TransactionStepObject

Basic information about an individual HTTP request during an RBU or VU test.

Method Summary

long	getBytes() Returns the total number of bytes transfered while making the HTTP request.
java.util.Date	getEnd() Returns the time and date the HTTP request ended.
java.lang.String	getErrorMessage() Returns descriptive text of any error that occurred while making the HTTP request.
java.lang.String	getHost() Returns the host part of the URL.
java.lang.String	getMethod() The HTTP method used for this request (usually "GET" or "POST").
java.lang.String	getPath() Returns the path of the URL.
java.lang.String	getProtocol() Returns the protocol part of the URL, usually "http" or "https".
java.lang.String	getQueryString() Returns the query string of the URL.
java.util.Date	getStart() Returns the time and date the HTTP request started.
int	getStatusCode() Returns the HTTP status code (eg: 200, 404, etc) that resulted when this request was made.
long	getTimeActive() Returns the total time the request was active, usually the time for the last byte to be received, but sometimes the time in which the request was aborted because the script had completed.
long	getTimeToFirstByte() Returns the time to receive the first byte back from the server.
java.lang.String	getUrl() Returns the full URL that this object represents.

Method Detail

getStart

java.util.Date getStart()

Returns the time and date the HTTP request started.

Returns:

the date and time the HTTP request started.

getEnd

java.util.Date getEnd()

Returns the time and date the HTTP request ended.

Returns:

the date and time the HTTP request ended.

getBytes

long getBytes()

Returns the total number of bytes transfered while making the HTTP request.

Returns:

the total number of bytes.

getUrl

java.lang.String getUrl()

Returns the full URL that this object represents.

Returns:

the URL requested.

getStatusCode

int getStatusCode()

Returns the HTTP status code (eg: 200, 404, etc) that resulted when this request was made. The code may be a non-standard HTTP code, such as -999 or -998, which indicates that the object did not complete before the overall script and/or transaction completed.

Returns:

the HTTP status code.

getHost

java.lang.String getHost()

Returns the host part of the URL.

Returns:

the host part of the URL.

getProtocol

java.lang.String getProtocol()

Returns the protocol part of the URL, usually "http" or "https".

Returns:

the protocol part of the URL.

getPath

java.lang.String getPath()

Returns the path of the URL. For example, if the URL is http://example.com/foo/bar?baz=1, the path will be "/foo/bar".

Returns:

the path part of the URL.

getQueryString

java.lang.String getQueryString()

Returns the query string of the URL. For example, if the URL is http://example.com/foo/bar?baz=1, the query string will be "baz=1"

Returns:

the query string part of the URL.

getTimeActive

long getTimeActive()

Returns the total time the request was active, usually the time for the last byte to be received, but sometimes the time in which the request was aborted because the script had completed.

Returns:

the time, in milliseconds, this request was active for.

getTimeToFirstByte

long getTimeToFirstByte()

Returns the time to receive the first byte back from the server. If no bytes were returned, then this function returns 0.

Returns:

the time, in milliseconds, to receive back the first byte from the server.

getMethod

java.lang.String getMethod()

The HTTP method used for this request (usually "GET" or "POST").

Returns:

the HTTP method used for this request.

getErrorMessage

java.lang.String getErrorMessage()

Returns descriptive text of any error that occurred while making the HTTP request. This message is usually coupled with an HTTP status code of -999 or -998, which is a BrowserMob-specific indicator that the request could not complete, usually due to some I/O exception. This error message can usually shed light on what the I/O issue was and is suitable to be thrown as an exception within the underlying script that made the HTTP request.

Returns:

the string error message or null if no error occurred or no message can be found.