Class ChunkedInputStream

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    @Deprecated
    public class ChunkedInputStream
    extends InputStream
    Deprecated.
    Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

    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 Detail

      • ChunkedInputStream

        public ChunkedInputStream​(InputStream in,
                                  HttpMethod method)
                           throws IOException
        Deprecated.
        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)
                           throws IOException
        Deprecated.
        ChunkedInputStream constructor
        Parameters:
        in - the raw input stream
        Throws:
        IOException - If an IO error occurs
    • Method Detail

      • read

        public int read()
                 throws IOException
        Deprecated.

        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.

        Specified by:
        read in class InputStream
        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:
        HttpMethod.getResponseFooters()
      • read

        public int read​(byte[] b,
                        int off,
                        int len)
                 throws IOException
        Deprecated.
        Read some bytes from the stream.
        Overrides:
        read in class 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:
        IOException - if an IO problem occurs.
        See Also:
        InputStream.read(byte[], int, int)
      • read

        public int read​(byte[] b)
                 throws IOException
        Deprecated.
        Read some bytes from the stream.
        Overrides:
        read in class 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:
        IOException - if an IO problem occurs.
        See Also:
        InputStream.read(byte[])
      • close

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