Package de.gematik.test.tiger.mockserver.model

Class HttpResponse

java.lang.Object

de.gematik.test.tiger.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

de.gematik.test.tiger.mockserver.model.ObjectWithJsonToString

de.gematik.test.tiger.mockserver.model.Action<HttpResponse>

de.gematik.test.tiger.mockserver.model.HttpResponse

All Implemented Interfaces:

HttpMessage<HttpResponse,BodyWithContentType>, Message

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

Nested Class Summary

Nested classes/interfaces inherited from class de.gematik.test.tiger.mockserver.model.Action

Action.Direction, Action.Type

Constructor Summary

Constructors

Constructor	Description
HttpResponse()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
HttpResponse	clone()
boolean	containsHeader(String name, String value)	Returns true if a header with the specified name has been added
boolean	equals(Object o)
BodyWithContentType	getBody()
byte[]	getBodyAsRawBytes()
String	getBodyAsString()
List<Cookie>	getCookieList()
Cookies	getCookies()
String	getFirstHeader(String name)
int	getHashCode()
List<String>	getHeader(String name)
List<Header>	getHeaderList()
com.google.common.collect.Multimap<String,String>	getHeaderMultimap()
Headers	getHeaders()
String	getReasonPhrase()
Integer	getStatusCode()
Integer	getStreamId()
Action.Type	getType()
int	hashCode()
static HttpResponse	notFoundResponse()	Static builder to create a not found response.
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
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.
void	setBody(BodyWithContentType body)
void	setCookies(Cookies cookies)
void	setHashCode(int hashCode)
void	setHeaders(Headers headers)
void	setReasonPhrase(String reasonPhrase)
void	setStatusCode(Integer statusCode)
void	setStreamId(Integer streamId)
String	toString()
HttpResponse	withBody(byte[] body)	Set response body to return as binary such as a pdf or image
HttpResponse	withBody(BodyWithContentType body)	Set the body to return for example:
HttpResponse	withBody(String body)	Set response body to return as a string response body.
HttpResponse	withBody(String body, MediaType contentType)	Set response body to return a string response body with the specified encoding.
HttpResponse	withBody(String body, Charset charset)	Set response body to return a string response body with the specified encoding.
HttpResponse	withCookies(Cookies cookies)
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(Headers headers)
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"
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
HttpResponse	withStreamId(Integer streamId)
void	write(NettyResponseWriter nettyResponseWriter, HttpRequest request)

Methods inherited from class de.gematik.test.tiger.mockserver.model.Action

getExpectationId, setExpectationId

Methods inherited from class de.gematik.test.tiger.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

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

Constructor Details

HttpResponse

public HttpResponse()

Method Details

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

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"

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

getBodyAsRawBytes

public byte[] getBodyAsRawBytes()

Specified by:

getBodyAsRawBytes in interface HttpMessage<HttpResponse,BodyWithContentType>

getBodyAsString

public String getBodyAsString()

Specified by:

getBodyAsString in interface HttpMessage<HttpResponse,BodyWithContentType>

withHeaders

public HttpResponse withHeaders(Headers headers)

Specified by:

withHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>

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

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

getHeaderList

public List<Header> getHeaderList()

Specified by:

getHeaderList in interface HttpMessage<HttpResponse,BodyWithContentType>

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>

removeHeader

public HttpResponse removeHeader(String 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

withCookies

public HttpResponse withCookies(Cookies cookies)

Specified by:

withCookies in interface HttpMessage<HttpResponse,BodyWithContentType>

getCookieList

public List<Cookie> getCookieList()

Specified by:

getCookieList in interface HttpMessage<HttpResponse,BodyWithContentType>

withStreamId

public HttpResponse withStreamId(Integer streamId)

getType

public Action.Type getType()

Specified by:

getType in class Action<HttpResponse>

write

public void write(NettyResponseWriter nettyResponseWriter,
 HttpRequest request)

Specified by:

write in class Action<HttpResponse>

clone

public HttpResponse clone()

Overrides:

clone in class Object

getHeaderMultimap

public com.google.common.collect.Multimap<String,String> getHeaderMultimap()

equals

public boolean equals(Object o)

Overrides:

equals in class Action<HttpResponse>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class Action<HttpResponse>

hashCode

public int hashCode()

Overrides:

hashCode in class Action<HttpResponse>

getHashCode

public int getHashCode()

getStatusCode

public Integer getStatusCode()

getReasonPhrase

public String getReasonPhrase()

getBody

public BodyWithContentType getBody()

Specified by:

getBody in interface HttpMessage<HttpResponse,BodyWithContentType>

getHeaders

public Headers getHeaders()

Specified by:

getHeaders in interface HttpMessage<HttpResponse,BodyWithContentType>

getCookies

public Cookies getCookies()

Specified by:

getCookies in interface HttpMessage<HttpResponse,BodyWithContentType>

getStreamId

public Integer getStreamId()

setHashCode

public void setHashCode(int hashCode)

setStatusCode

public void setStatusCode(Integer statusCode)

setReasonPhrase

public void setReasonPhrase(String reasonPhrase)

setBody

public void setBody(BodyWithContentType body)

setHeaders

public void setHeaders(Headers headers)

setCookies

public void setCookies(Cookies cookies)

setStreamId

public void setStreamId(Integer streamId)

toString

public String toString()

Overrides:

toString in class Action<HttpResponse>