Package org.apache.http.impl.io

Class 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.
      private long getChunkSize()
      Expects the stream to start with a chunksize in hex with optional comments after a semicolon.
      Header[] getFooters()  
      private void nextChunk()
      Read the next chunk.
      private void parseTrailerHeaders()
      Reads and stores the Trailer headers.
      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, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • state

        private int state

      • chunkSize

        private long chunkSize
        The chunk size

      • pos

        private long pos
        The current position within the current chunk

      • eof

        private boolean eof
        True if we've reached the end of stream

      • closed

        private boolean closed
        True if this stream is closed

      • footers

        private Header[] footers

    • Constructor Detail

      • ChunkedInputStream

        public ChunkedInputStream​(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

      • nextChunk

        private void nextChunk()
                throws java.io.IOException
        Read the next chunk.
        Throws:
        java.io.IOException - in case of an I/O error

      • getChunkSize

        private long getChunkSize()
                   throws java.io.IOException
        Expects the stream to start with a chunksize in hex with optional comments after a semicolon. The line must end with a CRLF: "a3; some comment\r\n" Positions the stream at the start of the next line.
        Throws:
        java.io.IOException

      • parseTrailerHeaders

        private void parseTrailerHeaders()
                          throws java.io.IOException
        Reads and stores the Trailer headers.
        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.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException - in case of an I/O error

      • getFooters

        public Header[] getFooters()