unirest

Class BinaryResponse

java.lang.Object

unirest.BinaryResponse

All Implemented Interfaces:

HttpResponse<InputStream>

public class BinaryResponse
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BinaryResponse(RawResponse response)

Method Summary

Modifier and Type	Method and Description
InputStream	getBody()
Headers	getHeaders()
Optional<UnirestParsingException>	getParsingError() If the transformation to the body failed by an exception it will be kept here
InputStream	getRawBody() This method is a lie.
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) This method is a lie.
protected void	setParsingException(String originalBody, RuntimeException e)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryResponse

protected BinaryResponse(RawResponse response)

Method Detail

getRawBody

public InputStream getRawBody()

Description copied from interface: HttpResponse

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

Specified by:

getRawBody in interface HttpResponse<InputStream>

Returns:

a copy of the input stream

getBody

public InputStream getBody()

Specified by:

getBody in interface HttpResponse<InputStream>

Returns:

the body

getStatus

public int getStatus()

Specified by:

getStatus in interface HttpResponse<T>

Returns:

the HTTP status code.

getStatusText

public String getStatusText()

Specified by:

getStatusText in interface HttpResponse<T>

Returns:

status text

getHeaders

public Headers getHeaders()

Specified by:

getHeaders in interface HttpResponse<T>

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"

getParsingError

public Optional<UnirestParsingException> 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 interface HttpResponse<T>

Returns:

a possible RuntimeException. Checked exceptions are wrapped in a UnirestException

mapBody

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

Specified by:

mapBody in interface HttpResponse<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

mapRawBody

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

Description copied from interface: HttpResponse

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

Specified by:

mapRawBody in interface HttpResponse<T>

Type Parameters:

V - the return type

Parameters:

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

Returns:

the return type

setParsingException

protected void setParsingException(String originalBody,
                                   RuntimeException e)

ifSuccess

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

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 interface HttpResponse<T>

Parameters:

consumer - a function to consume a HttpResponse

Returns:

the same response

ifFailure

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

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 interface HttpResponse<T>

Parameters:

consumer - a function to consume a HttpResponse

Returns:

the same response

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface HttpResponse<T>

Returns:

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