Package kong.unirest.core
Class BaseResponse<T>
java.lang.Object
kong.unirest.core.BaseResponse<T>
- All Implemented Interfaces:
HttpResponse<T>
- Direct Known Subclasses:
BasicResponse
,ByteResponse
,FileResponse
,JsonResponse
,MockResponse
,ObjectResponse
,StringResponse
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Config
private Cookies
private final Headers
private Optional
<UnirestParsingException> private final HttpRequestSummary
private final int
private final String
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BaseResponse
(BaseResponse other) protected
BaseResponse
(RawResponse response) -
Method Summary
Modifier and TypeMethodDescriptionabstract T
getBody()
return a cookie collection parse from the set-cookie headerprivate String
If the transformation to the body failed by an exception it will be kept hereprotected abstract String
int
<E> HttpResponse
<T> ifFailure
(Class<? extends E> errorClass, Consumer<HttpResponse<E>> consumer) If the response was NOT a 200-series response or a mapping exception happened.ifFailure
(Consumer<HttpResponse<T>> consumer) If the response was NOT a 200-series response or a mapping exception happened.ifSuccess
(Consumer<HttpResponse<T>> consumer) If the response was a 200-series response.boolean
<V> HttpResponse
<V> Map the Response into another response with a different body<V> V
Map the body into another type<E> E
Map the body into a error class if the response was NOT a 200-series response or a mapping exception happened.protected void
setParsingException
(String originalBody, RuntimeException e)
-
Field Details
-
headers
-
statusText
-
statusCode
private final int statusCode -
reqSummary
-
parsingerror
-
config
-
cookies
-
-
Constructor Details
-
BaseResponse
-
BaseResponse
-
-
Method Details
-
getStatus
public int getStatus()- Specified by:
getStatus
in interfaceHttpResponse<T>
- Returns:
- the HTTP status code.
-
getStatusText
- Specified by:
getStatusText
in interfaceHttpResponse<T>
- Returns:
- status text
-
getHeaders
- Specified by:
getHeaders
in interfaceHttpResponse<T>
- Returns:
- Response Headers (map) with same case as server response.
For instance use
getHeaders().getFirst("Location")
and notgetHeaders().getFirst("location")
to get first header "Location"
-
getBody
- Specified by:
getBody
in interfaceHttpResponse<T>
- Returns:
- the body
-
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>
- Returns:
- a possible RuntimeException. Checked exceptions are wrapped in a UnirestException
-
mapBody
Description copied from interface:HttpResponse
Map the body into another type- Specified by:
mapBody
in interfaceHttpResponse<T>
- Type Parameters:
V
- The return type of the function- Parameters:
func
- a function to transform a body type to something else.- Returns:
- the return type
-
map
Description copied from interface:HttpResponse
Map the Response into another response with a different body- Specified by:
map
in interfaceHttpResponse<T>
- Type Parameters:
V
- The return type of the function- Parameters:
func
- a function to transform a body type to something else.- Returns:
- the return type
-
setParsingException
-
isSuccess
public boolean isSuccess()- Specified by:
isSuccess
in interfaceHttpResponse<T>
- Returns:
- true if the response was a 200-series response and no mapping exception happened, else false
-
ifSuccess
Description copied from interface:HttpResponse
If the response was a 200-series response. Invoke this consumer can be chained with ifFailure- Specified by:
ifSuccess
in interfaceHttpResponse<T>
- Parameters:
consumer
- a function to consume a HttpResponse- Returns:
- the same response
-
ifFailure
Description copied from interface:HttpResponse
If the response was NOT a 200-series response or a mapping exception happened. Invoke this consumer can be chained with ifSuccess- Specified by:
ifFailure
in interfaceHttpResponse<T>
- Parameters:
consumer
- a function to consume a HttpResponse- Returns:
- the same response
-
mapError
Description copied from interface:HttpResponse
Map the body into a error class if the response was NOT a 200-series response or a mapping exception happened. Uses the system Object Mapper- Specified by:
mapError
in interfaceHttpResponse<T>
- Type Parameters:
E
- the response type- Parameters:
errorClass
- the class for the error- Returns:
- the error object
-
getErrorBody
-
ifFailure
public <E> HttpResponse<T> ifFailure(Class<? extends E> errorClass, Consumer<HttpResponse<E>> consumer) Description copied from interface:HttpResponse
If the response was NOT a 200-series response or a mapping exception happened. map the original body into a error type and invoke this consumer can be chained with ifSuccess- Specified by:
ifFailure
in interfaceHttpResponse<T>
- Type Parameters:
E
- the type of error class to map the body- Parameters:
errorClass
- the class of the error type to map toconsumer
- a function to consume a HttpResponse- Returns:
- the same response
-
getCookies
Description copied from interface:HttpResponse
return a cookie collection parse from the set-cookie header- Specified by:
getCookies
in interfaceHttpResponse<T>
- Returns:
- a Cookies collection
-
getRequestSummary
- Specified by:
getRequestSummary
in interfaceHttpResponse<T>
- Returns:
- a Summary of the HttpRequest that created this response
-
getRawBody
-