unirest

Interface HttpResponse<T>

Type Parameters:

T - a Http Response holding a specific type of body.

All Known Implementing Classes:

BinaryResponse, FileResponse, JsonResponse, StringResponse

public interface HttpResponse<T>

Method Summary

Modifier and Type	Method and Description
T	getBody()
Headers	getHeaders()
Optional<UnirestParsingException>	getParsingError() If the transformation to the body failed by an exception it will be kept here
InputStream	getRawBody() Deprecated. this method is redundant and not the original stream. Use the functional asObject methods.
int	getStatus()
String	getStatusText()
HttpResponse<T>	ifFailure(java.util.function.Consumer<HttpResponse<T>> consumer) If the response was NOT a 200-series response or a mapping exception happened.
HttpResponse<T>	ifSuccess(java.util.function.Consumer<HttpResponse<T>> consumer) If the response was a 200-series response.
boolean	isSuccess()
<V> V	mapBody(java.util.function.Function<T,V> func)
<V> V	mapRawBody(java.util.function.Function<InputStream,V> func) Deprecated.

Method Detail

getStatus

int getStatus()

Returns:

the HTTP status code.

getStatusText

String getStatusText()

Returns:

status text

getHeaders

Headers getHeaders()

Returns:

Response Headers (map) with same case as server response. For instance use getHeaders().getFirst("Location") and not getHeaders().getFirst("location") to get first header "Location"

getRawBody

@Deprecated
InputStream getRawBody()

Deprecated. this method is redundant and not the original stream. Use the functional asObject methods.

This method is a lie. You never get the real raw response from it you only get a copy, or worse, the body transformed BACK to a stream If you want to use raw content use the new functional methods

Returns:

a copy of the input stream

getBody

T getBody()

Returns:

the body

getParsingError

Optional<UnirestParsingException> getParsingError()

If the transformation to the body failed by an exception it will be kept here

Returns:

a possible RuntimeException. Checked exceptions are wrapped in a UnirestException

mapBody

<V> V mapBody(java.util.function.Function<T,V> func)

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

mapRawBody

@Deprecated
<V> V mapRawBody(java.util.function.Function<InputStream,V> func)

Deprecated.

This method is a lie. You never get the real raw response from it you only get a copy, or worse, the body transformed BACK to a stream If you want to use raw content use the new functional methods

Type Parameters:

V - the return type

Parameters:

func - a function to map a inputstream to a new body

Returns:

the return type

ifSuccess

HttpResponse<T> ifSuccess(java.util.function.Consumer<HttpResponse<T>> consumer)

If the response was a 200-series response. Invoke this consumer can be chained with ifFailure

Parameters:

consumer - a function to consume a HttpResponse

Returns:

the same response

ifFailure

HttpResponse<T> ifFailure(java.util.function.Consumer<HttpResponse<T>> consumer)

If the response was NOT a 200-series response or a mapping exception happened. Invoke this consumer can be chained with ifSuccess

Parameters:

consumer - a function to consume a HttpResponse

Returns:

the same response

isSuccess

boolean isSuccess()

Returns:

true if the response was a 200-series response and no mapping exception happened, else false