| java.lang.Object
 java.io.InputStream
org.apache.commons.httpclient.ChunkedInputStream
| ChunkedInputStream | | public class ChunkedInputStream extends InputStream (Code) | | 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.
author:
Ortwin Glueck
author:
Sean C. Sullivan
author:
Martin Elwin
author:
Eric Johnson
author:
Mike Bowler
author:
Michael Becke
author:
Oleg Kalnichevski
since:
2.0 |
| Method Summary | |
| public 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. | | static void | exhaustInputStream(InputStream inStream)
Exhaust an input stream, reading until EOF has been encountered. | | public int | read()
Returns all the data in a chunked stream in coalesced form. | | public int | read(byte[] b, int off, int len)
Read some bytes from the stream.
Parameters:
b - The byte array that will hold the contents from the stream.
Parameters:
off - The offset into the byte array at which bytes will start to beplaced.
Parameters:
len - the maximum number of bytes that can be returned. | | public int | read(byte[] b)
Read some bytes from the stream.
Parameters:
b - The byte array that will hold the contents from the stream. |
| ChunkedInputStream | | public ChunkedInputStream(InputStream in, HttpMethod method) throws IOException(Code) | | ChunkedInputStream constructor that associates the chunked input stream with a
HttpMethod HTTP method . Usually it should be the same
HttpMethod HTTP method the chunked input stream originates from. If chunked input stream
contains any footers (trailing headers), they will be added to the associated
HttpMethod HTTP method .
Parameters:
in - the raw input stream
Parameters:
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(Code) | | ChunkedInputStream constructor
Parameters:
in - the raw input stream
throws:
IOException - If an IO error occurs |
| close | | public void close() throws IOException(Code) | | 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.
throws:
IOException - If an IO problem occurs. |
| exhaustInputStream | | static void exhaustInputStream(InputStream inStream) throws IOException(Code) | | Exhaust an input stream, reading until EOF has been encountered.
Note that this function is intended as a non-public utility.
This is a little weird, but it seemed silly to make a utility
class for this one function, so instead it is just static and
shared that way.
Parameters:
inStream - The InputStream to exhaust.
throws:
IOException - If an IO problem occurs |
| read | | public int read() throws IOException(Code) | | 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.
-1 of the end of the stream has been reached or the next databyte
throws:
IOException - If an IO problem occurs
See Also: HttpMethod.getResponseFooters |
| read | | public int read(byte[] b, int off, int len) throws IOException(Code) | | Read some bytes from the stream.
Parameters:
b - The byte array that will hold the contents from the stream.
Parameters:
off - The offset into the byte array at which bytes will start to beplaced.
Parameters:
len - the maximum number of bytes that can be returned. The number of bytes returned or -1 if the end of stream has beenreached.
See Also: java.io.InputStream.read(byte[]intint)
throws:
IOException - if an IO problem occurs. |
| read | | public int read(byte[] b) throws IOException(Code) | | Read some bytes from the stream.
Parameters:
b - The byte array that will hold the contents from the stream. The number of bytes returned or -1 if the end of stream has beenreached.
See Also: java.io.InputStream.read(byte[])
throws:
IOException - if an IO problem occurs. |
|
|