org.apache.http.impl.io

Class ChunkedInputStream

java.lang.Object

java.io.InputStream

org.apache.http.impl.io.ChunkedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ChunkedInputStream
extends java.io.InputStream

Implements chunked transfer coding. The content is received in small chunks. Entities transferred using this input stream can be of unlimited length. After the stream is read to the end, it provides access to the trailers, if any.

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 execution of subsequent HTTP 1.1 requests, while not requiring the client to remember to read the entire contents of the response.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
ChunkedInputStream(org.apache.http.io.SessionInputBuffer in) Wraps session input stream and reads chunk coded input.
ChunkedInputStream(org.apache.http.io.SessionInputBuffer in, org.apache.http.config.MessageConstraints constraints) Wraps session input stream and reads chunk coded input.

Method Summary

Modifier and Type	Method and Description
int	available()
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.
org.apache.http.Header[]	getFooters()
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

mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedInputStream

public ChunkedInputStream(org.apache.http.io.SessionInputBuffer in,
                          org.apache.http.config.MessageConstraints constraints)

Wraps session input stream and reads chunk coded input.

Parameters:

in - The session input buffer

constraints - Message constraints. If null MessageConstraints.DEFAULT will be used.

Since:

4.4

ChunkedInputStream

public ChunkedInputStream(org.apache.http.io.SessionInputBuffer in)

Wraps session input stream and reads chunk coded input.

Parameters:

in - The session input buffer

Method Detail

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.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 automatically at the end of the stream and can be obtained with the getResponseFooters() method.

Specified by:

read in class java.io.InputStream

Returns:

-1 of the end of the stream has been reached or the next data byte

Throws:

java.io.IOException - in case of an I/O error

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Read some bytes from the stream.

Overrides:

read in class java.io.InputStream

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:

java.io.IOException - in case of an I/O error

read

public int read(byte[] b)
         throws java.io.IOException

Read some bytes from the stream.

Overrides:

read in class java.io.InputStream

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:

java.io.IOException - in case of an I/O error

close

public void close()
           throws java.io.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 java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - in case of an I/O error

getFooters

public org.apache.http.Header[] getFooters()