org.apache.commons.httpclient

Class ChunkedInputStream

Implemented Interfaces:
Closeable

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

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)
Read some bytes from the stream.
int
read(byte[] b, int off, int len)
Read some bytes from the stream.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChunkedInputStream

public ChunkedInputStream(InputStream in)
            throws IOException
ChunkedInputStream constructor
Parameters:
in - the raw input stream
Throws:
IOException - If an IO error occurs
Usages and Demos :

View More Examples of ChunkedInputStream(InputStream in)
   1:                     if (transferEncoding.getValue().indexOf("chunked") != -1) {
   2:                         in = new ChunkedInputStream(in);
   3:                     }
   4:                 } else if (contentLength != null) {
   5:                     long len = getContentLength();

View Full Code Here
   1:                 if (transferEncoding.getValue().indexOf("chunked") != -1) {
   2:                     in = new ChunkedInputStream(in);
   3:                 }
   4:             } else if (contentLength != null) {
   5:                 long len = getContentLength();

View Full Code Here
   1:             {
   2:                 inStream = new ChunkedInputStream( connection.getInputStream() );
   3:             }
   4:         }

View Full Code Here

ChunkedInputStream

public ChunkedInputStream(InputStream in,
                          HttpMethod method)
            throws IOException
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

Method Details

close

public void close()
            throws IOException
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.
Specified by:
close in interface Closeable
Overrides:
close in interface InputStream
Throws:
IOException - If an IO problem occurs.

read

public int read()
            throws IOException
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.

Overrides:
read in interface InputStream
Returns:
-1 of the end of the stream has been reached or the next data byte
Throws:
IOException - If an IO problem occurs

read

public int read(byte[] b)
            throws IOException
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[])

read

public int read(byte[] b,
                int off,
                int len)
            throws IOException
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)