Class ChunkedInputStream
java.lang.Object
java.io.InputStream
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.ChunkedInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
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
ConstructorDescriptionChunkedInputStream constructorChunkedInputStream
(InputStream in, HttpMethod method) ChunkedInputStream constructor that associates the chunked input stream with aHTTP method
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
-
Constructor Details
-
ChunkedInputStream
ChunkedInputStream constructor that associates the chunked input stream with aHTTP method
. Usually it should be the sameHTTP method
the chunked input stream originates from. If chunked input stream contains any footers (trailing headers), they will be added to the associatedHTTP method
.- Parameters:
in
- the raw input streammethod
- the HTTP method to associate this input stream with. Can be null.- Throws:
IOException
- If an IO error occurs
-
ChunkedInputStream
ChunkedInputStream constructor- Parameters:
in
- the raw input stream- Throws:
IOException
- If an IO error occurs
-
-
Method Details
-
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.
- Specified by:
read
in classInputStream
- 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:
-
read
Read some bytes from the stream.- Overrides:
read
in classInputStream
- 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:
-
read
Read some bytes from the stream.- Overrides:
read
in classInputStream
- 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:
-
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.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- If an IO problem occurs.
-