org.apache.commons.httpclient
public class ChunkedInputStream extends InputStream
Transparently coalesces chunks of a HTTP stream that uses Transfer-Encoding chunked.
Note that this class NEVER closes the underlying stream, even when close gets called. Instead, it will read until the "end" of its chunking on close, which allows for the seamless invocation of subsequent HTTP 1.1 calls, while not requiring the client to remember to read the entire contents of the response.
Since: 2.0
Constructor Summary | |
---|---|
ChunkedInputStream(InputStream in, HttpMethod method)
ChunkedInputStream constructor that associates the chunked input stream with a
{@link HttpMethod HTTP method}. | |
ChunkedInputStream(InputStream in)
ChunkedInputStream constructor
|
Method Summary | |
---|---|
void | close()
Upon close, this reads the remainder of the chunked message,
leaving the underlying socket at a position to start reading the
next response without scanning. |
int | read() Returns all the data in a chunked stream in coalesced form. |
int | read(byte[] b, int off, int len)
Read some bytes from the stream. |
int | read(byte[] b)
Read some bytes from the stream. |
Parameters: in the raw input stream method the HTTP method to associate this input stream with. Can be null.
Throws: IOException If an IO error occurs
Parameters: in the raw input stream
Throws: IOException If an IO error occurs
Throws: IOException If an IO problem occurs.
Returns all the data in a chunked stream in coalesced form. A chunk is followed by a CRLF. The method returns -1 as soon as a chunksize of 0 is detected.
Trailer headers are read automcatically at the end of the stream and can be obtained with the getResponseFooters() method.
Returns: -1 of the end of the stream has been reached or the next data byte
Throws: IOException If an IO problem occurs
See Also: getResponseFooters
Parameters: b The byte array that will hold the contents from the stream. off The offset into the byte array at which bytes will start to be placed. len the maximum number of bytes that can be returned.
Returns: The number of bytes returned or -1 if the end of stream has been reached.
Throws: IOException if an IO problem occurs.
See Also: java.io.InputStream#read(byte[], int, int)
Parameters: b The byte array that will hold the contents from the stream.
Returns: The number of bytes returned or -1 if the end of stream has been reached.
Throws: IOException if an IO problem occurs.
See Also: java.io.InputStream#read(byte[])