HttpResponse (MockServer 5.13.1 API)

java.lang.Object
- org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString
- - org.mockserver.model.ObjectWithJsonToString
  - - org.mockserver.model.Action<HttpResponse>
    - - org.mockserver.model.HttpResponse

All Implemented Interfaces:: HttpMessage<HttpResponse,BodyWithContentType>, Message

public class HttpResponse
extends Action<HttpResponse>
implements HttpMessage<HttpResponse,BodyWithContentType>

Author:: jamesdbloom

Nested Class Summary
- Nested classes/interfaces inherited from class org.mockserver.model.Action
  Action.Direction, Action.Type

Constructor Summary

Constructors
Constructor and Description

HttpResponse()

Constructors
Constructor and Description
`HttpResponse()`

Method Summary

All Methods Static Methods Instance Methods Concrete 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
`boolean`	`cookieHeadeDoesNotAlreadyExists(Cookie cookieValue)`
`boolean`	`cookieHeadeDoesNotAlreadyExists(String name, String value)`
`boolean`	`equals(Object o)`
`BodyWithContentType`	`getBody()`
`byte[]`	`getBodyAsRawBytes()`
`String`	`getBodyAsString()`
`ConnectionOptions`	`getConnectionOptions()`
`List<Cookie>`	`getCookieList()`
`Map<NottableString,NottableString>`	`getCookieMap()`
`Cookies`	`getCookies()`
`String`	`getFirstHeader(String name)`
`List<String>`	`getHeader(String name)`
`List<Header>`	`getHeaderList()`
`com.google.common.collect.Multimap<NottableString,NottableString>`	`getHeaderMultimap()`
`Headers`	`getHeaders()`
`String`	`getReasonPhrase()`
`Integer`	`getStatusCode()`
`Action.Type`	`getType()`
`int`	`hashCode()`
`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`	`shallowClone()`
`HttpResponse`	`update(HttpResponse responseOverride, HttpResponseModifier responseModifier)`
`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, 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`	`withContentType(MediaType mediaType)`
`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/8/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(NottableString name, NottableString... 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`	`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, getExpectationId, setExpectationId, withDelay, withDelay

Methods inherited from class org.mockserver.model.ObjectWithJsonToString
toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString
fieldsExcludedFromEqualsAndHashCode

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).
    
    Specified by:
    
    withBody in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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.
    
    Specified by:
    
    withBody in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    body - a string
    
    charset - character set the string will be encoded in
  - withBody
```
public HttpResponse withBody(String body,
                             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
    
    Specified by:
    
    withBody in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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));
    
    Specified by:
    
    withBody in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    body - an instance of one of the Body subclasses including StringBody or BinaryBody
  - getBody
```
public BodyWithContentType getBody()
```
    Specified by:
    
    getBody in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getBodyAsRawBytes
```
public byte[] getBodyAsRawBytes()
```
    Specified by:
    
    getBodyAsRawBytes in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getBodyAsString
```
public String getBodyAsString()
```
    Specified by:
    
    getBodyAsString in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getHeaders
```
public Headers getHeaders()
```
    Specified by:
    
    getHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>
  - withHeaders
```
public HttpResponse withHeaders(Headers headers)
```
    Specified by:
    
    withHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>
  - withHeaders
```
public HttpResponse withHeaders(List<Header> headers)
```
    The headers to return as a list of Header objects
    
    Specified by:
    
    withHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    headers - a list of Header objects
  - withHeaders
```
public HttpResponse withHeaders(Header... headers)
```
    The headers to return as a varargs of Header objects
    
    Specified by:
    
    withHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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
    
    Specified by:
    
    withHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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
    
    Specified by:
    
    withHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    name - the header name
    
    values - the header values
  - withHeader
```
public HttpResponse withHeader(NottableString name,
                               NottableString... 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
    
    Specified by:
    
    withHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    name - the header name as a NottableString
    
    values - the header values which can be a varags of NottableStrings
  - withContentType
```
public HttpResponse withContentType(MediaType mediaType)
```
    Specified by:
    
    withContentType in interface HttpMessage<HttpResponse,BodyWithContentType>
  - 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
    
    Specified by:
    
    replaceHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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()
```
    Specified by:
    
    getHeaderList in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getHeaderMultimap
```
public com.google.common.collect.Multimap<NottableString,NottableString> getHeaderMultimap()
```
  - getHeader
```
public List<String> getHeader(String name)
```
    Specified by:
    
    getHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getFirstHeader
```
public String getFirstHeader(String name)
```
    Specified by:
    
    getFirstHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
  - containsHeader
```
public boolean containsHeader(String name)
```
    Returns true if a header with the specified name has been added
    
    Specified by:
    
    containsHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    name - the header name
    
    Returns:
    
    true if a header has been added with that name otherwise false
  - removeHeader
```
public HttpResponse removeHeader(String name)
```
    Specified by:
    
    removeHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
  - removeHeader
```
public HttpResponse removeHeader(NottableString name)
```
    Specified by:
    
    removeHeader in interface HttpMessage<HttpResponse,BodyWithContentType>
  - 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
  - getCookies
```
public Cookies getCookies()
```
    Specified by:
    
    getCookies in interface HttpMessage<HttpResponse,BodyWithContentType>
  - withCookies
```
public HttpResponse withCookies(Cookies cookies)
```
    Specified by:
    
    withCookies in interface HttpMessage<HttpResponse,BodyWithContentType>
  - withCookies
```
public HttpResponse withCookies(List<Cookie> cookies)
```
    The cookies to return as Set-Cookie headers as a list of Cookie objects
    
    Specified by:
    
    withCookies in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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
    
    Specified by:
    
    withCookies in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    cookies - a varargs of Cookie objects
  - withCookie
```
public HttpResponse withCookie(Cookie cookie)
```
    Add cookie to return as Set-Cookie header
    
    Specified by:
    
    withCookie in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    cookie - a Cookie object
  - withCookie
```
public HttpResponse withCookie(String name,
                               String value)
```
    Add cookie to return as Set-Cookie header
    
    Specified by:
    
    withCookie in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    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/8/docs/api/java/util/regex/Pattern.html)
    
    Specified by:
    
    withCookie in interface HttpMessage<HttpResponse,BodyWithContentType>
    
    Parameters:
    
    name - the cookies name
    
    value - the cookies value
  - getCookieList
```
public List<Cookie> getCookieList()
```
    Specified by:
    
    getCookieList in interface HttpMessage<HttpResponse,BodyWithContentType>
  - getCookieMap
```
public Map<NottableString,NottableString> getCookieMap()
```
  - cookieHeadeDoesNotAlreadyExists
```
public boolean cookieHeadeDoesNotAlreadyExists(Cookie cookieValue)
```
  - cookieHeadeDoesNotAlreadyExists
```
public boolean cookieHeadeDoesNotAlreadyExists(String name,
                                               String value)
```
  - 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>
  - shallowClone
```
public HttpResponse shallowClone()
```
  - clone
```
public HttpResponse clone()
```
    Overrides:
    
    clone in class Object
  - update
```
public HttpResponse update(HttpResponse responseOverride,
                           HttpResponseModifier responseModifier)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Action<HttpResponse>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Action<HttpResponse>

Class HttpResponse

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.mockserver.model.Action

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

Methods inherited from class java.lang.Object

Constructor Detail

HttpResponse

Method Detail

response

response

notFoundResponse

withStatusCode

getStatusCode

withReasonPhrase

getReasonPhrase

withBody

withBody

withBody

withBody

withBody

getBody

getBodyAsRawBytes

getBodyAsString

getHeaders

withHeaders

withHeaders

withHeaders

withHeader

withHeader

withHeader

withContentType

replaceHeader

replaceHeader

getHeaderList

getHeaderMultimap

getHeader

getFirstHeader

containsHeader

removeHeader

removeHeader

containsHeader

getCookies

withCookies

withCookies

withCookies

withCookie

withCookie

withCookie

getCookieList

getCookieMap

cookieHeadeDoesNotAlreadyExists

cookieHeadeDoesNotAlreadyExists

withConnectionOptions

getConnectionOptions

getType

shallowClone

clone

update

equals

hashCode