org.mockserver.model

Class HttpResponse

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Action<HttpResponse>

org.mockserver.model.HttpResponse

public class HttpResponse
extends Action<HttpResponse>

Author:

jamesdbloom

Nested Class Summary

Nested classes/interfaces inherited from class org.mockserver.model.Action

Action.Type

Constructor Summary

Constructors

Constructor and Description
HttpResponse()

Method Summary

Methods

Modifier and Type	Method and Description
HttpResponse	clone()
boolean	containsHeader(String name) Returns true if a header with the specified name has been added
boolean	containsHeader(String name, String value) Returns true if a header with the specified name has been added
BodyWithContentType	getBody()
String	getBodyAsString()
ConnectionOptions	getConnectionOptions()
List<Cookie>	getCookieList()
Cookies	getCookies()
String	getFirstHeader(String name)
List<String>	getHeader(String name)
List<Header>	getHeaderList()
Headers	getHeaders()
String	getReasonPhrase()
Integer	getStatusCode()
Action.Type	getType()
static HttpResponse	notFoundResponse() Static builder to create a not found response.
HttpResponse	removeHeader(NottableString name)
HttpResponse	removeHeader(String name)
HttpResponse	replaceHeader(Header header) Update header to return as a Header object, if a header with the same name already exists it will be modified
HttpResponse	replaceHeader(String name, String... values) Update header to return as a Header object, if a header with the same name already exists it will be modified
static HttpResponse	response() Static builder to create a response.
static HttpResponse	response(String body) Static builder to create a response with a 200 status code and the string response body.
HttpResponse	withBody(BodyWithContentType body) Set the body to return for example: string body: - exact(" a simple string body "); or - new StringBody(" a simple string body ") binary body: - binary(IOUtils.readFully(getClass().getClassLoader().getResourceAsStream("example.pdf"), 1024)); or - new BinaryBody(IOUtils.readFully(getClass().getClassLoader().getResourceAsStream("example.pdf"), 1024));
HttpResponse	withBody(byte[] body) Set response body to return as binary such as a pdf or image
HttpResponse	withBody(String body) Set response body to return as a string response body.
HttpResponse	withBody(String body, Charset charset) Set response body to return a string response body with the specified encoding.
HttpResponse	withBody(String body, com.google.common.net.MediaType contentType) Set response body to return a string response body with the specified encoding.
HttpResponse	withConnectionOptions(ConnectionOptions connectionOptions) The connection options for override the default connection behaviour, this allows full control of headers such as "Connection" or "Content-Length" or controlling whether the socket is closed after the response has been sent
HttpResponse	withCookie(Cookie cookie) Add cookie to return as Set-Cookie header
HttpResponse	withCookie(NottableString name, NottableString value) Adds one cookie to match on or to not match on using the NottableString, each NottableString can either be a positive matching value, such as string("match"), or a value to not match on, such as not("do not match"), the string values passed to the NottableString can be a plain string or a regex (for more details of the supported regex syntax see http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html)
HttpResponse	withCookie(String name, String value) Add cookie to return as Set-Cookie header
HttpResponse	withCookies(Cookie... cookies) The cookies to return as Set-Cookie headers as a varargs of Cookie objects
HttpResponse	withCookies(Cookies cookies)
HttpResponse	withCookies(List<Cookie> cookies) The cookies to return as Set-Cookie headers as a list of Cookie objects
HttpResponse	withHeader(Header header) Add a header to return as a Header object, if a header with the same name already exists this will NOT be modified but two headers will exist
HttpResponse	withHeader(String name, String... values) Add a header to return as a Header object, if a header with the same name already exists this will NOT be modified but two headers will exist
HttpResponse	withHeaders(Header... headers) The headers to return as a varargs of Header objects
HttpResponse	withHeaders(Headers headers)
HttpResponse	withHeaders(List<Header> headers) The headers to return as a list of Header objects
HttpResponse	withReasonPhrase(String reasonPhrase) The reason phrase to return, if no reason code is returned this will be defaulted to the standard reason phrase for the statusCode, i.e.
HttpResponse	withStatusCode(Integer statusCode) The status code to return, such as 200, 404, the status code specified here will result in the default status message for this status code for example for 200 the status message "OK" is used

Methods inherited from class org.mockserver.model.Action

getDelay, withDelay, withDelay

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

equals, fieldsExcludedFromEqualsAndHashCode, hashCode, key

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpResponse

public HttpResponse()

Method Detail

response

public static HttpResponse response()

Static builder to create a response.

response

public static HttpResponse response(String body)

Static builder to create a response with a 200 status code and the string response body.

Parameters:

body - a string

notFoundResponse

public static HttpResponse notFoundResponse()

Static builder to create a not found response.

withStatusCode

public HttpResponse withStatusCode(Integer statusCode)

The status code to return, such as 200, 404, the status code specified here will result in the default status message for this status code for example for 200 the status message "OK" is used

Parameters:

statusCode - an integer such as 200 or 404

getStatusCode

public Integer getStatusCode()

withReasonPhrase

public HttpResponse withReasonPhrase(String reasonPhrase)

The reason phrase to return, if no reason code is returned this will be defaulted to the standard reason phrase for the statusCode, i.e. for a statusCode of 200 the standard reason phrase is "OK"

Parameters:

reasonPhrase - an string such as "Not Found" or "OK"

getReasonPhrase

public String getReasonPhrase()

withBody

public HttpResponse withBody(String body)

Set response body to return as a string response body. The character set will be determined by the Content-Type header on the response. To force the character set, use withBody(String, Charset).

Parameters:

body - a string

withBody

public HttpResponse withBody(String body,
                    Charset charset)

Set response body to return a string response body with the specified encoding. Note: The character set of the response will be forced to the specified charset, even if the Content-Type header specifies otherwise.

Parameters:

body - a string

charset - character set the string will be encoded in

withBody

public HttpResponse withBody(String body,
                    com.google.common.net.MediaType contentType)

Set response body to return a string response body with the specified encoding. Note: The character set of the response will be forced to the specified charset, even if the Content-Type header specifies otherwise.

Parameters:

body - a string

contentType - media type, if charset is included this will be used for encoding string

withBody

public HttpResponse withBody(byte[] body)

Set response body to return as binary such as a pdf or image

Parameters:

body - a byte array

withBody

public HttpResponse withBody(BodyWithContentType body)

Set the body to return for example:

string body: - exact("

a simple string body

");

or

- new StringBody("

a simple string body

")

binary body: - binary(IOUtils.readFully(getClass().getClassLoader().getResourceAsStream("example.pdf"), 1024));

or

- new BinaryBody(IOUtils.readFully(getClass().getClassLoader().getResourceAsStream("example.pdf"), 1024));

Parameters:

body - an instance of one of the Body subclasses including StringBody or BinaryBody

getBody

public BodyWithContentType getBody()

getBodyAsString

public String getBodyAsString()

getHeaders

public Headers getHeaders()

withHeaders

public HttpResponse withHeaders(Headers headers)

withHeaders

public HttpResponse withHeaders(List<Header> headers)

The headers to return as a list of Header objects

Parameters:

headers - a list of Header objects

withHeaders

public HttpResponse withHeaders(Header... headers)

The headers to return as a varargs of Header objects

Parameters:

headers - varargs of Header objects

withHeader

public HttpResponse withHeader(Header header)

Add a header to return as a Header object, if a header with the same name already exists this will NOT be modified but two headers will exist

Parameters:

header - a Header object

withHeader

public HttpResponse withHeader(String name,
                      String... values)

Add a header to return as a Header object, if a header with the same name already exists this will NOT be modified but two headers will exist

Parameters:

name - the header name

values - the header values

replaceHeader

public HttpResponse replaceHeader(Header header)

Update header to return as a Header object, if a header with the same name already exists it will be modified

Parameters:

header - a Header object

replaceHeader

public HttpResponse replaceHeader(String name,
                         String... values)

Update header to return as a Header object, if a header with the same name already exists it will be modified

Parameters:

name - the header name

values - the header values

getHeaderList

public List<Header> getHeaderList()

getHeader

public List<String> getHeader(String name)

getFirstHeader

public String getFirstHeader(String name)

containsHeader

public boolean containsHeader(String name)

Returns true if a header with the specified name has been added

Parameters:

name - the header name

Returns:

true if a header has been added with that name otherwise false

removeHeader

public HttpResponse removeHeader(String name)

removeHeader

public HttpResponse removeHeader(NottableString name)

getCookies

public Cookies getCookies()

withCookies

public HttpResponse withCookies(Cookies cookies)

containsHeader

public boolean containsHeader(String name,
                     String value)

Returns true if a header with the specified name has been added

Parameters:

name - the header name

value - the header value

Returns:

true if a header has been added with that name otherwise false

withCookies

public HttpResponse withCookies(List<Cookie> cookies)

The cookies to return as Set-Cookie headers as a list of Cookie objects

Parameters:

cookies - a list of Cookie objects

withCookies

public HttpResponse withCookies(Cookie... cookies)

The cookies to return as Set-Cookie headers as a varargs of Cookie objects

Parameters:

cookies - a varargs of Cookie objects

withCookie

public HttpResponse withCookie(Cookie cookie)

Add cookie to return as Set-Cookie header

Parameters:

cookie - a Cookie object

withCookie

public HttpResponse withCookie(String name,
                      String value)

Add cookie to return as Set-Cookie header

Parameters:

name - the cookies name

value - the cookies value

withCookie

public HttpResponse withCookie(NottableString name,
                      NottableString value)

Adds one cookie to match on or to not match on using the NottableString, each NottableString can either be a positive matching value, such as string("match"), or a value to not match on, such as not("do not match"), the string values passed to the NottableString can be a plain string or a regex (for more details of the supported regex syntax see http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html)

Parameters:

name - the cookies name

value - the cookies value

getCookieList

public List<Cookie> getCookieList()

withConnectionOptions

public HttpResponse withConnectionOptions(ConnectionOptions connectionOptions)

The connection options for override the default connection behaviour, this allows full control of headers such as "Connection" or "Content-Length" or controlling whether the socket is closed after the response has been sent

Parameters:

connectionOptions - the connection options for override the default connection behaviour

getConnectionOptions

public ConnectionOptions getConnectionOptions()

getType

public Action.Type getType()

Specified by:

getType in class Action<HttpResponse>

clone

public HttpResponse clone()

Overrides:

clone in class Object