com.jcabi.http.response

Class JsoupResponse

java.lang.Object

com.jcabi.http.response.JsoupResponse

All Implemented Interfaces:

Response

@Immutable
public final class JsoupResponse
extends Object

Jsoup response.

This response decorator is able to parse HTTP response body as an HTML document. Example usage:

 String body = new JdkRequest("http://my.example.com")
   .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON)
   .fetch()
   .as(JsoupResponse.class)
   .body();

body() will try to output clean HTML even for malformed responses. For example:

• Unclosed tags will be closed ("<p>Hello" will become "<p>Hello</p>")
• Implicit tags will be made explicit (e.g. a naked <td> will be wrapped in a <table><trgt;<td>?)
• Basic structure is guaranteed (i.e. html, head, body elements)

The class is immutable and thread-safe.

Since:

1.4

Version:

$Id: e531a49154590b301fc1515e963ac684f54aaa1e $

Author:

Carlos Miranda ([email protected])

See Also:

Jsoup website

Constructor Summary

Constructors

Constructor and Description
JsoupResponse(Response resp) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Response> 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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsoupResponse

public JsoupResponse(@NotNull(message="response can\'t be NULL")
             Response resp)

Public ctor.

Parameters:

resp - Response

Method Detail

body

public String body()

Description copied from interface: Response

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 Response.binary() instead.

Specified by:

body in interface Response

Returns:

The body, as a UTF-8 string

toString

public final String toString()

Overrides:

toString in class Object

back

public final Request back()

Description copied from interface: Response

Get back to the request it's related to.

Specified by:

back in interface Response

Returns:

The request we're in

status

public final int status()

Description copied from interface: Response

Get status of the response as a positive integer number.

Specified by:

status in interface Response

Returns:

The status code

reason

public final String reason()

Description copied from interface: Response

Get status line reason phrase.

Specified by:

reason in interface Response

Returns:

The status line reason phrase

headers

public final Map<String,List<String>> headers()

Description copied from interface: Response

Get a collection of all headers.

Specified by:

headers in interface Response

Returns:

The headers

binary

public final byte[] binary()

Description copied from interface: Response

Raw body as a an array of bytes.

Specified by:

binary in interface Response

Returns:

The body, as a UTF-8 string

as

public final <T extends Response> T as(Class<T> type)

Convert it to another type, by encapsulation.

Specified by:

as in interface Response

Type Parameters:

T - Type to use

Parameters:

type - Type to use

Returns:

New response