io.restassured.builder

Class ResponseBuilder

java.lang.Object

io.restassured.builder.ResponseBuilder

public class ResponseBuilder
extends Object

A builder to make it easier to create new Response implementations. This is useful if you're working with Filters and want to change the response you get from the sever somehow.

Constructor Summary

Constructors

Constructor and Description
ResponseBuilder()

Method Summary

Modifier and Type	Method and Description
Response	build() Build the actual response
ResponseBuilder	clone(Response response) Clone an already existing response.
ResponseBuilder	setBody(byte[] bytes) Set the response body to an array of bytes
ResponseBuilder	setBody(InputStream inputStream) Set the response body to an inputstream
ResponseBuilder	setBody(String stringBody) Set the response body to a String
ResponseBuilder	setContentType(ContentType contentType) Set the content type of the response
ResponseBuilder	setContentType(String contentType) Set the content type of the response
ResponseBuilder	setCookies(Cookies cookies) Set some cookies that will be available in the response.
ResponseBuilder	setHeader(String name, String value) Set a specific header
ResponseBuilder	setHeaders(Headers headers) Set response headers, e.g:
ResponseBuilder	setStatusCode(int statusCode) Set the status code of the response.
ResponseBuilder	setStatusLine(String statusLine) Set the status line of the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseBuilder

public ResponseBuilder()

Method Detail

clone

public ResponseBuilder clone(Response response)

Clone an already existing response.

Returns:

Builder.

setBody

public ResponseBuilder setBody(String stringBody)

Set the response body to a String

Returns:

Builder.

setBody

public ResponseBuilder setBody(InputStream inputStream)

Set the response body to an inputstream

Returns:

Builder.

setBody

public ResponseBuilder setBody(byte[] bytes)

Set the response body to an array of bytes

Returns:

Builder.

setHeaders

public ResponseBuilder setHeaders(Headers headers)

Set response headers, e.g:

 Header first = new Header("headerName1", "headerValue1");
 Header second = new Header("headerName2", "headerValue2");
 Headers headers = new Header(first, second);
 

Returns:

The builder

See Also:

Headers

setCookies

public ResponseBuilder setCookies(Cookies cookies)

Set some cookies that will be available in the response. To create cookies you can do:

 Cookie cookie1 = Cookie.Builder("username", "John").setComment("comment 1").build();
 Cookie cookie2 = Cookie.Builder("token", 1234).setComment("comment 2").build();
 Cookies cookies = new Cookies(cookie1, cookie2);
 

Returns:

The Builder

setContentType

public ResponseBuilder setContentType(String contentType)

Set the content type of the response

Returns:

The builder

setContentType

public ResponseBuilder setContentType(ContentType contentType)

Set the content type of the response

Returns:

The builder

setHeader

public ResponseBuilder setHeader(String name,
                                 String value)

Set a specific header

Returns:

The builder

setStatusLine

public ResponseBuilder setStatusLine(String statusLine)

Set the status line of the response.

Returns:

The builder

setStatusCode

public ResponseBuilder setStatusCode(int statusCode)

Set the status code of the response.

Returns:

The builder

build

public Response build()

Build the actual response

Returns:

The response object