com.jayway.restassured.response

Interface ExtractableResponse<R extends ResponseOptions<R>>

All Superinterfaces:

ResponseBodyData, ResponseBodyExtractionOptions

All Known Implementing Classes:

RestAssuredResponseImpl, RestAssuredResponseOptionsImpl

public interface ExtractableResponse<R extends ResponseOptions<R>>
extends ResponseBodyExtractionOptions

The response of a request made by REST Assured.

Usage example:

 Response response = get("/lotto");
 String body = response.getBody().asString();
 String headerValue = response.getHeader("headerName");
 String cookieValue = response.getCookie("cookieName");
 

You can also map the response body to a Java object automatically. REST Assured will use Jackson, Gson and JAXB to accommodate this:

 Message message = get("/message").as(Message.class);
 

Method Summary

Modifier and Type	Method and Description
ResponseBodyExtractionOptions	body() Returns the response body
String	contentType() Get the content type of the response
String	cookie(String name) Get a single cookie value associated with the given name.
Map<String,String>	cookies() The response cookies as simple name/value pair.
Cookie	detailedCookie(String name) Get a single cookie including all attributes associated with the given name.
Cookies	detailedCookies() The response cookies with all the attributes.
String	header(String name) Get a single header value associated with the given name.
Headers	headers() The response headers.
R	response()
String	sessionId() Get the session id from the response.
int	statusCode() Get the status code of the response.
String	statusLine() Get the status line of the response.
long	time()
long	timeIn(TimeUnit timeUnit)

Methods inherited from interface com.jayway.restassured.response.ResponseBodyExtractionOptions

as, as, as, htmlPath, jsonPath, jsonPath, path, xmlPath, xmlPath, xmlPath

Methods inherited from interface com.jayway.restassured.response.ResponseBodyData

asByteArray, asInputStream, asString

Method Detail

body

ResponseBodyExtractionOptions body()

Returns the response body

Returns:

The response body.

headers

Headers headers()

The response headers. If there are several response headers with the same name a list of the response header values are returned.

Returns:

The response headers.

header

String header(String name)

Get a single header value associated with the given name. If the header is a multi-value header then you need to use Headers.getList(String) in order to get all values.

Returns:

The header value or null if value was not found.

cookies

Map<String,String> cookies()

The response cookies as simple name/value pair. It assumes that no cookies have the same name. If two cookies should never the less have the same name the Last cookie value is used. If you want to return ALL cookies including all the details such as Max-Age etc use detailedCookies().

Returns:

The response cookies.

detailedCookies

Cookies detailedCookies()

The response cookies with all the attributes. It also gives you the possibility to get multi-value cookies.

Returns:

The response cookies.

cookie

String cookie(String name)

Get a single cookie value associated with the given name. If you want more details than just the value use detailedCookie(String).

Returns:

The cookie value or null if value was not found.

detailedCookie

Cookie detailedCookie(String name)

Get a single cookie including all attributes associated with the given name.

Returns:

The cookie value or null if value was not found.

contentType

String contentType()

Get the content type of the response

Returns:

The content type value or null if not found.

statusLine

String statusLine()

Get the status line of the response.

Returns:

The status line of the response.

sessionId

String sessionId()

Get the session id from the response. The session id name can be configured from the SessionConfig.

Returns:

The session id of the response or null if not defined.

statusCode

int statusCode()

Get the status code of the response.

Returns:

The status code of the response.

response

R response()

Returns:

The entire response object including headers, cookies and body etc.

time

long time()

Returns:

The response time in milliseconds (or -1 if no response time could be measured)

timeIn

long timeIn(TimeUnit timeUnit)

Returns:

The response time in the given time unit (or -1 if no response time could be measured)