|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.io.InputStream | +--org.apache.commons.httpclient.ChunkedInputStream
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.
ResponseInputStream
Constructor Summary | |
ChunkedInputStream(java.io.InputStream in,
HttpMethod method)
|
Method Summary | |
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. |
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,
reset,
skip |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public ChunkedInputStream(java.io.InputStream in, HttpMethod method) throws java.io.IOException
in
- must be non-nullmethod
- must be non-nullMethod Detail |
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 automcatically at the end of the stream and can be obtained with the getResponseFooters() method.
HttpMethod.getResponseFooters()
public int read(byte[] b, int off, int len) throws java.io.IOException
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.InputStream.read(byte[], int, int)
public int read(byte[] b) throws java.io.IOException
b
- The byte array that will hold the contents from the stream.InputStream.read(byte[])
public void close() throws java.io.IOException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |