kong.unirest.HttpResponse Maven / Gradle / Ivy
The newest version!
/**
* The MIT License
*
* Copyright for portions of unirest-java are held by Kong Inc (c) 2013.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package kong.unirest;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Function;
/**
* @param a Http Response holding a specific type of body.
*/
public interface HttpResponse {
/**
* @return the HTTP status code.
*/
int getStatus();
/**
* @return status text
*/
String getStatusText();
/**
* @return 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"
*/
Headers getHeaders();
/**
* @return the body
*/
T getBody();
/**
* If the transformation to the body failed by an exception it will be kept here
* @return a possible RuntimeException. Checked exceptions are wrapped in a UnirestException
*/
Optional getParsingError();
/**
* Map the body into another type
* @param func a function to transform a body type to something else.
* @param The return type of the function
* @return the return type
*/
V mapBody(Function func);
/**
* Map the Response into another response with a different body
* @param func a function to transform a body type to something else.
* @param The return type of the function
* @return the return type
*/
HttpResponse map(Function func);
/**
* If the response was a 200-series response. Invoke this consumer
* can be chained with ifFailure
* @param consumer a function to consume a HttpResponse
* @return the same response
*/
HttpResponse ifSuccess(Consumer> consumer);
/**
* If the response was NOT a 200-series response or a mapping exception happened. Invoke this consumer
* can be chained with ifSuccess
* @param consumer a function to consume a HttpResponse
* @return the same response
*/
HttpResponse ifFailure(Consumer> consumer);
/**
* 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
* @param the type of error class to map the body
* @param errorClass the class of the error type to map to
* @param consumer a function to consume a HttpResponse
* @return the same response
*/
HttpResponse ifFailure(Class errorClass, Consumer> consumer);
/**
* @return true if the response was a 200-series response and no mapping exception happened, else false
*/
boolean isSuccess();
/**
* 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
* @param the response type
* @param errorClass the class for the error
* @return the error object
*/
E mapError(Class errorClass);
/**
* return a cookie collection parse from the set-cookie header
* @return a Cookies collection
*/
Cookies getCookies();
}