com.jcabi.http

Interface Response

All Known Implementing Classes:

JsonResponse, RestResponse, WebLinkingResponse, XmlResponse

@Immutable
public interface Response

RESTful response returned by Request.fetch().

You can get this response from one of implementations of Request:

 Response response = new JdkRequest("https://www.google.com")
   .header("Accept", "text/html")
   .fetch();

Instances of this interface are immutable and thread-safe.

Since:

0.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

JdkRequest

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	as(Class<T> type) Convert it to another type, by encapsulation.
Request	back() Get back to the request it's related to.
byte[]	binary() Raw body as a an array of bytes.
String	body() Get body as a string, assuming it's UTF-8 (if there is something else that can't be translated into a UTF-8 string a runtime exception will be thrown).
Map<String,List<String>>	headers() Get a collection of all headers.
String	reason() Get status line reason phrase.
int	status() Get status of the response as a positive integer number.

Method Detail

back

@NotNull(message="request is never NULL")
Request back()

Get back to the request it's related to.

Returns:

The request we're in

status

int status()

Get status of the response as a positive integer number.

Returns:

The status code

reason

@NotNull(message="reason phrase is never NULL")
String reason()

Get status line reason phrase.

Returns:

The status line reason phrase

headers

@NotNull(message="map of headers is never NULL")
Map<String,List<String>> headers()

Get a collection of all headers.

Returns:

The headers

body

@NotNull(message="response body is never NULL")
String body()

Get body as a string, assuming it's UTF-8 (if there is something else that can't be translated into a UTF-8 string a runtime exception will be thrown).

DISCLAIMER: The only encoding supported here is UTF-8. If the body of response contains any chars that can't be used and should be replaced with a "replacement character", a RuntimeException will be thrown. If you need to use some other encodings, use binary() instead.

Returns:

The body, as a UTF-8 string

binary

@NotNull(message="response data is never NULL")
byte[] binary()

Raw body as a an array of bytes.

Returns:

The body, as a UTF-8 string

as

<T> T as(Class<T> type)

Convert it to another type, by encapsulation.

Type Parameters:

T - Type to use

Parameters:

type - Type to use

Returns:

New response

Suppressed Checkstyle violations:

MethodName (3 lines)