org.apache.commons.httpclient

Class ChunkedInputStream

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

Author: Ortwin Glueck Sean C. Sullivan Martin Elwin Eric Johnson Mike Bowler Michael Becke Oleg Kalnichevski

Constructor Summary
ChunkedInputStream(InputStream in, HttpMethod method)
ChunkedInputStream constructor that associates the chunked input stream with a HTTP method.
ChunkedInputStream(InputStream in)
ChunkedInputStream constructor
Method Summary
voidclose()
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.
intread()

Returns all the data in a chunked stream in coalesced form.

intread(byte[] b, int off, int len)
Read some bytes from the stream.
intread(byte[] b)
Read some bytes from the stream.

Constructor Detail

ChunkedInputStream

public ChunkedInputStream(InputStream in, HttpMethod method)
ChunkedInputStream constructor that associates the chunked input stream with a HTTP method. Usually it should be the same HTTP method the chunked input stream originates from. If chunked input stream contains any footers (trailing headers), they will be added to the associated HTTP method.

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

ChunkedInputStream

public ChunkedInputStream(InputStream in)
ChunkedInputStream constructor

Parameters: in the raw input stream

Throws: IOException If an IO error occurs

Method Detail

close

public 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.

Throws: IOException If an IO problem occurs.

read

public int read()

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

read

public int read(byte[] b, int off, int len)
Read some bytes from the stream.

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)

read

public int read(byte[] b)
Read some bytes from the stream.

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[])

Copyright (c) 1999-2005 - Apache Software Foundation