Package org.jsoup.helper

Class HttpConnection.Response

java.lang.Object

org.jsoup.helper.HttpConnection.Base<Connection.Response>

org.jsoup.helper.HttpConnection.Response

All Implemented Interfaces:

Connection.Base<Connection.Response>, Connection.Response

Enclosing class:

HttpConnection

public static class HttpConnection.Response
extends HttpConnection.Base<Connection.Response>
implements Connection.Response

Field Summary

Fields

Modifier and Type	Field	Description
private ControllableInputStream	bodyStream
private ByteBuffer	byteData
private String	charset
(package private) int	contentLength
(package private) String	contentType
private boolean	executed
(package private) RequestExecutor	executor
private boolean	inputStreamRead
private static final String	LOCATION
private static final int	MAX_REDIRECTS
private int	numRedirects
private final HttpConnection.Request	req
(package private) int	statusCode
(package private) String	statusMessage
private static final Pattern	xmlContentTypeRxp

Fields inherited from class org.jsoup.helper.HttpConnection.Base

cookies, headers, method, url

Constructor Summary

Constructors

Constructor	Description
Response()	Internal only! Creates a dummy HttpConnection.Response, useful for testing.
Response(HttpConnection.Request request)

Method Summary

Modifier and Type	Method	Description
String	body()	Get the body of the response as a plain String.
byte[]	bodyAsBytes()	Get the body of the response as an array of bytes.
BufferedInputStream	bodyStream()	Get the body of the response as a (buffered) InputStream.
Connection.Response	bufferUp()	Read the body of the response into a local buffer, so that Connection.Response.parse() may be called repeatedly on the same connection response.
String	charset()	Get the character set name of the response, derived from the content-type header.
HttpConnection.Response	charset(String charset)	Set / override the response character set.
String	contentType()	Get the response content type (e.g.
(package private) static HttpConnection.Response	execute(HttpConnection.Request req)
(package private) static HttpConnection.Response	execute(HttpConnection.Request req, HttpConnection.Response prevRes)
(package private) static String	fixHeaderEncoding(String val)	Servers may encode response headers in UTF-8 instead of RFC defined 8859.
private static void	implWritePost(HttpConnection.Request req, BufferedWriter w, OutputStream outputStream)
private static boolean	looksLikeUtf8(byte[] input)
Document	parse()	Read and parse the body of the response as a Document.
private ControllableInputStream	prepareParse()	Called from parse() or streamParser(), validates and prepares the input stream, and aligns common settings.
(package private) void	prepareResponse(Map<String,List<String>> resHeaders, HttpConnection.Response previousResponse)
(package private) void	processResponseHeaders(Map<String,List<String>> resHeaders)
String	readBody()	Read the response body, and returns it as a plain String.
private void	readByteDataUnchecked()	Reads the body, but throws an UncheckedIOException if an IOException occurs.
Connection.Response	readFully()	Reads the bodyStream into byteData.
private void	safeClose()	Call on completion of stream read, to close the body (or error) stream.
private static void	serialiseRequestUrl(Connection.Request req)
private static void	setOutputContentType(HttpConnection.Request req)
int	statusCode()	Get the status code of the response.
String	statusMessage()	Get the status message of the response.
StreamParser	streamParser()	Returns a StreamParser that will parse the Response progressively.
(package private) static void	writePost(HttpConnection.Request req, OutputStream outputStream)

Methods inherited from class org.jsoup.helper.HttpConnection.Base

addHeader, cookie, cookie, cookies, hasCookie, hasHeader, hasHeaderWithValue, header, header, headers, headers, method, method, multiHeaders, removeCookie, removeHeader, url, url

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jsoup.Connection.Base

addHeader, cookie, cookie, cookies, hasCookie, hasHeader, hasHeaderWithValue, header, header, headers, headers, method, method, multiHeaders, removeCookie, removeHeader, url, url

Field Details

MAX_REDIRECTS

private static final int MAX_REDIRECTS

See Also:

• Constant Field Values

LOCATION

private static final String LOCATION

See Also:

• Constant Field Values

statusCode

int statusCode

statusMessage

String statusMessage

byteData

private ByteBuffer byteData

bodyStream

private ControllableInputStream bodyStream

executor

RequestExecutor executor

charset

private String charset

contentType

String contentType

contentLength

int contentLength

executed

private boolean executed

inputStreamRead

private boolean inputStreamRead

numRedirects

private int numRedirects

req

private final HttpConnection.Request req

xmlContentTypeRxp

private static final Pattern xmlContentTypeRxp

Constructor Details

Response

Response()

Internal only! Creates a dummy HttpConnection.Response, useful for testing. All actual responses are created from the HttpURLConnection and fields defined.

Response

Response(HttpConnection.Request request)

Method Details

execute

static HttpConnection.Response execute(HttpConnection.Request req)
                                throws IOException

Throws:

IOException

execute

static HttpConnection.Response execute(HttpConnection.Request req,
 HttpConnection.Response prevRes)
                                throws IOException

Throws:

IOException

statusCode

public int statusCode()

Description copied from interface: Connection.Response

Get the status code of the response.

Specified by:

statusCode in interface Connection.Response

Returns:

status code

statusMessage

public String statusMessage()

Description copied from interface: Connection.Response

Get the status message of the response.

Specified by:

statusMessage in interface Connection.Response

Returns:

status message

charset

public String charset()

Description copied from interface: Connection.Response

Get the character set name of the response, derived from the content-type header.

Specified by:

charset in interface Connection.Response

Returns:

character set name if set, null if not

charset

public HttpConnection.Response charset(String charset)

Description copied from interface: Connection.Response

Set / override the response character set. When the document body is parsed it will be with this charset.

Specified by:

charset in interface Connection.Response

Parameters:

charset - to decode body as

Returns:

this Response, for chaining

contentType

public String contentType()

Description copied from interface: Connection.Response

Get the response content type (e.g. "text/html");

Specified by:

contentType in interface Connection.Response

Returns:

the response content type, or null if one was not set

prepareParse

private ControllableInputStream prepareParse()

Called from parse() or streamParser(), validates and prepares the input stream, and aligns common settings.

parse

public Document parse()
               throws IOException

Description copied from interface: Connection.Response

Read and parse the body of the response as a Document. If you intend to parse the same response multiple times, you should Connection.Response.readFully() first, which will buffer the body into memory.

Specified by:

parse in interface Connection.Response

Returns:

a parsed Document

Throws:

IOException - if an IO exception occurs whilst reading the body.

See Also:

• Connection.Response.readFully()

streamParser

public StreamParser streamParser()
                          throws IOException

Description copied from interface: Connection.Response

Returns a StreamParser that will parse the Response progressively.

Specified by:

streamParser in interface Connection.Response

Returns:

a StreamParser, prepared to parse this response.

Throws:

IOException - if an IO exception occurs preparing the parser.

readFully

public Connection.Response readFully()
                              throws IOException

Reads the bodyStream into byteData. A no-op if already executed.

Specified by:

readFully in interface Connection.Response

Returns:

this response, for chaining

Throws:

IOException - if an IO exception occurs during buffering.

readByteDataUnchecked

private void readByteDataUnchecked()

Reads the body, but throws an UncheckedIOException if an IOException occurs.

Throws:

UncheckedIOException - if an IOException occurs

readBody

public String readBody()
                throws IOException

Description copied from interface: Connection.Response

Read the response body, and returns it as a plain String.

Specified by:

readBody in interface Connection.Response

Returns:

body

Throws:

IOException - if an IO exception occurs whilst reading the body.

body

public String body()

Description copied from interface: Connection.Response

Get the body of the response as a plain String.

Will throw an UncheckedIOException if the body has not been buffered and an error occurs whilst reading the body; use Connection.Response.readFully() first to buffer the body and catch any exceptions explicitly. Or more simply, Connection.Response.readBody().

Specified by:

body in interface Connection.Response

Returns:

body

See Also:

• Connection.Response.readBody()
• Connection.Response.readFully()

bodyAsBytes

public byte[] bodyAsBytes()

Description copied from interface: Connection.Response

Get the body of the response as an array of bytes.

Will throw an UncheckedIOException if the body has not been buffered and an error occurs whilst reading the body; use Connection.Response.readFully() first to buffer the body and catch any exceptions explicitly.

Specified by:

bodyAsBytes in interface Connection.Response

Returns:

body bytes

See Also:

• Connection.Response.readFully()

bufferUp

public Connection.Response bufferUp()

Description copied from interface: Connection.Response

Read the body of the response into a local buffer, so that Connection.Response.parse() may be called repeatedly on the same connection response. Otherwise, once the response is read, its InputStream will have been drained and may not be re-read.

Calling Connection.Response.body() or Connection.Response.bodyAsBytes() has the same effect.

Specified by:

bufferUp in interface Connection.Response

Returns:

this response, for chaining

bodyStream

public BufferedInputStream bodyStream()

Description copied from interface: Connection.Response

Get the body of the response as a (buffered) InputStream. You should close the input stream when you're done with it.

Other body methods (like readFully, body, parse, etc) will generally not work in conjunction with this method, as it consumes the InputStream.

Any configured max size or maximum read timeout applied to the connection will not be applied to this stream, unless Connection.Response.readFully() is called prior.

This method is useful for writing large responses to disk, without buffering them completely into memory first.

Specified by:

bodyStream in interface Connection.Response

Returns:

the response body input stream

safeClose

private void safeClose()

Call on completion of stream read, to close the body (or error) stream. The connection.disconnect allows keep-alives to work (as the underlying connection is actually held open, despite the name).

prepareResponse

void prepareResponse(Map<String,List<String>> resHeaders,
 HttpConnection.Response previousResponse)
              throws IOException

Throws:

IOException

processResponseHeaders

void processResponseHeaders(Map<String,List<String>> resHeaders)

fixHeaderEncoding

static String fixHeaderEncoding(String val)

Servers may encode response headers in UTF-8 instead of RFC defined 8859. The JVM decodes the headers (before we see them) as 8859, which can lead to mojibake data.

This method attempts to detect that and re-decode the string as UTF-8.

However on Android, the headers will be decoded as UTF8, so we can detect and pass those directly.

Parameters:

val - a header value string that may have been incorrectly decoded as 8859.

Returns:

a potentially re-decoded string.

looksLikeUtf8

private static boolean looksLikeUtf8(byte[] input)

setOutputContentType

private static void setOutputContentType(HttpConnection.Request req)

writePost

static void writePost(HttpConnection.Request req,
 OutputStream outputStream)
               throws IOException

Throws:

IOException

implWritePost

private static void implWritePost(HttpConnection.Request req,
 BufferedWriter w,
 OutputStream outputStream)
                           throws IOException

Throws:

IOException

serialiseRequestUrl

private static void serialiseRequestUrl(Connection.Request req)
                                 throws IOException

Throws:

IOException