Package kong.unirest.core
Class MockResponse<T>
java.lang.Object
kong.unirest.core.BaseResponse<T>
kong.unirest.core.MockResponse<T>
- Type Parameters:
T
- the body type
- All Implemented Interfaces:
HttpResponse<T>
A Mock Response that can be used in testing.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final T
private Optional
<UnirestParsingException> private final MockConfig
-
Constructor Summary
ConstructorsConstructorDescriptionMockResponse
(int status, String statusText, T body) Construct a mock ResponseMockResponse
(int status, String statusText, T body, MockConfig config) Construct a mock Response -
Method Summary
Modifier and TypeMethodDescriptionstatic <T> MockResponse
<T> bad
(T body) Construct a simple failed (400 bad request) response with a bodyconfig()
get the MockConfig for this MockResponseFlag that there was a post-processing parsing error with the object Mapper this jams the body as a string into the parsing exception and sets a generic oops exceptionfailedToParse
(Exception e, String originalBody) Flag that there was a post-processing parsing error with the object MappergetBody()
If the transformation to the body failed by an exception it will be kept hereprotected String
static <T> MockResponse
<T> Construct a response with a status and body.static <T> MockResponse
<T> of
(int status, T body) Construct a response with a status and body.static <T> MockResponse
<T> ok
(T body) Construct a simple successful (200 ok) response with a bodySet some options on the current MockConfig.withHeader
(String key, String value) add a header value to the responseMethods inherited from class kong.unirest.core.BaseResponse
getCookies, getHeaders, getRequestSummary, getStatus, getStatusText, ifFailure, ifFailure, ifSuccess, isSuccess, map, mapBody, mapError, setParsingException
-
Field Details
-
mockConfig
-
ex
-
body
-
-
Constructor Details
-
MockResponse
Construct a mock Response- Parameters:
status
- the status of the responsestatusText
- the status textbody
- the body
-
MockResponse
Construct a mock Response- Parameters:
status
- the status of the responsestatusText
- the status textbody
- the bodyconfig
- a mockConfig for post-processing options
-
-
Method Details
-
ok
Construct a simple successful (200 ok) response with a body- Type Parameters:
T
- the type of body- Parameters:
body
- the body- Returns:
- a MockResponse;
-
bad
Construct a simple failed (400 bad request) response with a body- Type Parameters:
T
- the type of body- Parameters:
body
- the body- Returns:
- a MockResponse;
-
of
Construct a response with a status and body. The status text is just the string of the status- Type Parameters:
T
- the type of body- Parameters:
status
- the statusbody
- the body- Returns:
- a MockResponse;
-
of
Construct a response with a status and body. The status text is just the string of the status- Type Parameters:
T
- the type of body- Parameters:
status
- the statusstatusText
- the status textbody
- the body- Returns:
- a MockResponse;
-
config
get the MockConfig for this MockResponse- Returns:
- the config
-
getBody
- Specified by:
getBody
in interfaceHttpResponse<T>
- Specified by:
getBody
in classBaseResponse<T>
- Returns:
- the body
-
getRawBody
- Specified by:
getRawBody
in classBaseResponse<T>
-
getParsingError
Description copied from interface:HttpResponse
If the transformation to the body failed by an exception it will be kept here- Specified by:
getParsingError
in interfaceHttpResponse<T>
- Overrides:
getParsingError
in classBaseResponse<T>
- Returns:
- a possible RuntimeException. Checked exceptions are wrapped in a UnirestException
-
withHeader
add a header value to the response- Parameters:
key
- the header keyvalue
- the header value- Returns:
- this MockResponse
-
failedToParse
Flag that there was a post-processing parsing error with the object Mapper this jams the body as a string into the parsing exception and sets a generic oops exception- Returns:
- this MockResponse
-
failedToParse
Flag that there was a post-processing parsing error with the object Mapper- Parameters:
e
- the exception thrownoriginalBody
- the original body before the object mapper got involved.- Returns:
- this MockResponse
-
withConfigOptions
Set some options on the current MockConfig.- Parameters:
c
- a Consumer with options to set on the config- Returns:
- this MockResponse
-