DefaultResponse (REST Server Driver 1.1.27 API)

java.lang.Object
- com.github.restdriver.serverdriver.http.response.DefaultResponse

All Implemented Interfaces:

Response
```
public final class DefaultResponse
extends Object
implements Response
```
Our class which describes an HTTP response.

Field Summary
- Fields inherited from interface com.github.restdriver.serverdriver.http.response.Response
  MAX_BODY_DISPLAY_LENGTH

Constructor Summary

Constructors
Constructor and Description

DefaultResponse(org.apache.http.HttpResponse response, long responseTime)
Constructor from apache HttpResponse.

Constructors
Constructor and Description
`DefaultResponse(org.apache.http.HttpResponse response, long responseTime)` Constructor from apache HttpResponse.

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 `Response.toString()` to System.out, but without truncating the response body.
`void`	`dump()` Prints the output of `Response.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 `Response.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultResponse
```
public DefaultResponse(org.apache.http.HttpResponse response,
               long responseTime)
```
    Constructor from apache HttpResponse.
    
    Parameters:
    response - the HttpResponse
    responseTime - time taken for the request in milliseconds
- Method Detail
  - getStatusCode
```
public int getStatusCode()
```
    Description copied from interface: Response
    
    What was the response code?
    
    Specified by:
    
    getStatusCode in interface Response
    
    Returns:
    the HTTP status code of the response
  - getContent
```
public String getContent()
```
    Description copied from interface: Response
    
    What was the content of the response?
    
    Specified by:
    
    getContent in interface Response
    
    Returns:
    The response body content as a string
  - asText
```
public String asText()
```
    Description copied from interface: Response
    
    What was the content of the response?
    
    Specified by:
    
    asText in interface Response
    
    Returns:
    The response body content as a string
  - getHeaders
```
public List<Header> getHeaders()
```
    Description copied from interface: Response
    
    What headers did the server send?
    
    Specified by:
    
    getHeaders in interface Response
    
    Returns:
    A list of headers
  - getHeaders
```
public List<Header> getHeaders(String headerName)
```
    Description copied from interface: Response
    
    Get the all headers with the specified name.
    
    Specified by:
    
    getHeaders in interface Response
    
    Parameters:
    headerName - The name of the header
    
    Returns:
    The Headers associated with that name. Possibly an empty list.
  - getHeader
```
public Header getHeader(String headerName)
```
    Description copied from interface: Response
    
    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 Response.getHeaders(String).
    
    Specified by:
    
    getHeader in interface Response
    
    Parameters:
    headerName - The name of the header
    
    Returns:
    The Header associated with that name. Possibly null.
  - getResponseTime
```
public long getResponseTime()
```
    Description copied from interface: Response
    
    How long did the response take?
    
    Specified by:
    
    getResponseTime in interface Response
    
    Returns:
    Round-trip response time in milliseconds
  - asJson
```
public com.fasterxml.jackson.databind.JsonNode asJson()
```
    Description copied from interface: Response
    
    Returns the JSON response content as a JsonNode, or throws RuntimeMappingException.
    
    Specified by:
    
    asJson in interface Response
    
    Returns:
    The JsonNode
  - asXml
```
public Element asXml()
```
    Description copied from interface: Response
    
    Returns the XML response content as an org.w3c.Element, or throws RuntimeMappingException.
    
    Specified by:
    
    asXml in interface Response
    
    Returns:
    The Element
  - toString
```
public String toString()
```
    Description copied from interface: Response
    
    Returns the response headers and body, truncating the body.
    
    Specified by:
    
    toString in interface Response
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The String
  - toBigString
```
public String toBigString()
```
    Description copied from interface: Response
    
    Returns the response headers and body, without truncating the body.
    
    Specified by:
    
    toBigString in interface Response
    
    Returns:
    The String
  - toCompactString
```
public String toCompactString()
```
    Description copied from interface: Response
    
    Returns the response as a compact single-line String.
    
    Specified by:
    
    toCompactString in interface Response
    
    Returns:
    The String
  - tinyDump
```
public void tinyDump()
```
    Description copied from interface: Response
    
    Prints the output of Response.toCompactString() to System.out.
    
    Specified by:
    
    tinyDump in interface Response
  - dump
```
public void dump()
```
    Description copied from interface: Response
    
    Prints the output of Response.toString() to System.out.
    
    Specified by:
    
    dump in interface Response
  - bigDump
```
public void bigDump()
```
    Description copied from interface: Response
    
    Prints the output of Response.toString() to System.out, but without truncating the response body. This could be a very large dump.
    
    Specified by:
    
    bigDump in interface Response
  - asBytes
```
public byte[] asBytes()
```
    Description copied from interface: Response
    
    The body of the response as a byte array, for dealing with binary data or troubleshooting encoding issues.
    
    Specified by:
    
    asBytes in interface Response
    
    Returns:
    The body of the HTTP response as a byte array

Class DefaultResponse

Field Summary

Fields inherited from interface com.github.restdriver.serverdriver.http.response.Response

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultResponse

Method Detail

getStatusCode

getContent

asText

getHeaders

getHeaders

getHeader

getResponseTime

asJson

asXml

toString

toBigString

toCompactString

tinyDump

dump

bigDump

asBytes