com.github.restdriver.serverdriver.http.response

Interface Response

All Known Implementing Classes:

DefaultResponse

public interface Response

Encapsulates a response from an HTTP server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BODY_DISPLAY_LENGTH The maximum number of response body characters to display.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	asBytes() The body of the response as a byte array, for dealing with binary data or troubleshooting encoding issues.
com.fasterxml.jackson.databind.JsonNode	asJson() Returns the JSON response content as a JsonNode, or throws RuntimeMappingException.
String	asText() What was the content of the response?
Element	asXml() Returns the XML response content as an org.w3c.Element, or throws RuntimeMappingException.
void	bigDump() Prints the output of toString() to System.out, but without truncating the response body.
void	dump() Prints the output of toString() to System.out.
String	getContent() What was the content of the response?
Header	getHeader(String headerName) Get the value of an individual Header.
List<Header>	getHeaders() What headers did the server send?
List<Header>	getHeaders(String headerName) Get the all headers with the specified name.
long	getResponseTime() How long did the response take?
int	getStatusCode() What was the response code?
void	tinyDump() Prints the output of toCompactString() to System.out.
String	toBigString() Returns the response headers and body, without truncating the body.
String	toCompactString() Returns the response as a compact single-line String.
String	toString() Returns the response headers and body, truncating the body.

Field Detail

MAX_BODY_DISPLAY_LENGTH

static final int MAX_BODY_DISPLAY_LENGTH

The maximum number of response body characters to display.

See Also:

Constant Field Values

Method Detail

getStatusCode

int getStatusCode()

What was the response code?

Returns:

the HTTP status code of the response

getContent

String getContent()

What was the content of the response?

Returns:

The response body content as a string

asText

String asText()

What was the content of the response?

Returns:

The response body content as a string

asBytes

byte[] asBytes()

The body of the response as a byte array, for dealing with binary data or troubleshooting encoding issues.

Returns:

The body of the HTTP response as a byte array

getHeaders

List<Header> getHeaders()

What headers did the server send?

Returns:

A list of headers

getHeaders

List<Header> getHeaders(String headerName)

Get the all headers with the specified name.

Parameters:

headerName - The name of the header

Returns:

The Headers associated with that name. Possibly an empty list.

getHeader

Header getHeader(String headerName)

Get the value of an individual Header. If there are multiple values for the same header, this method will return the first one found. If you expect there to be multiple values for the same header then you should use getHeaders(String).

Parameters:

headerName - The name of the header

Returns:

The Header associated with that name. Possibly null.

getResponseTime

long getResponseTime()

How long did the response take?

Returns:

Round-trip response time in milliseconds

asJson

com.fasterxml.jackson.databind.JsonNode asJson()

Returns the JSON response content as a JsonNode, or throws RuntimeMappingException.

Returns:

The JsonNode

asXml

Element asXml()

Returns the XML response content as an org.w3c.Element, or throws RuntimeMappingException.

Returns:

The Element

toCompactString

String toCompactString()

Returns the response as a compact single-line String.

Returns:

The String

toString

String toString()

Returns the response headers and body, truncating the body.

Overrides:

toString in class Object

Returns:

The String

toBigString

String toBigString()

Returns the response headers and body, without truncating the body.

Returns:

The String

tinyDump

void tinyDump()

Prints the output of toCompactString() to System.out.

dump

void dump()

Prints the output of toString() to System.out.

bigDump

void bigDump()

Prints the output of toString() to System.out, but without truncating the response body. This could be a very large dump.