io.induct.http

Interface Response

All Superinterfaces:

java.lang.AutoCloseable

public interface Response
extends java.lang.AutoCloseable

Generic HTTP response wrapper.

Since:

15.2.2015

Method Summary

Modifier and Type	Method and Description
void	close() Allow the use of try-with-resources block to only read the minimal amount of data.
com.google.common.base.Optional<java.io.InputStream>	getResponseBody() Access response body if one is available.
com.google.common.collect.Multimap<java.lang.String,java.lang.String>	getResponseHeaders() Access response headers.
int	getStatusCode() Access response status code.

Method Detail

getStatusCode

int getStatusCode()

Access response status code. Abstraction for making status codes human readable is not provided as tons of libraries provide such already.

Returns:

HTTP status code of the response

getResponseHeaders

com.google.common.collect.Multimap<java.lang.String,java.lang.String> getResponseHeaders()

Access response headers. As with request headers in the request APIs of HttpClient, the returned headers are assumed to be a multimap as it is possible to respond with, for example, multiple Set-Cookie headers.

Returns:

Response headers

getResponseBody

com.google.common.base.Optional<java.io.InputStream> getResponseBody()

Access response body if one is available. The response body can be expected to be the whole body, not multipart or stream.

Returns:

Optionally available response body.

close

void close()

Allow the use of try-with-resources block to only read the minimal amount of data. Exact behavior is implementation specific and is considered optional to implement.

Specified by:

close in interface java.lang.AutoCloseable