org.apache.commons.httpclient
Class ChunkedInputStream
java.lang.Object
|
+--java.io.InputStream
|
+--org.apache.commons.httpclient.ChunkedInputStream
- public class ChunkedInputStream
- extends java.io.InputStream
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
- Author:
- Ortwin Glück, Sean C. Sullivan, Martin Elwin, Eric Johnson
- See Also:
ResponseInputStream
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)
|
int |
read(byte[] b,
int off,
int len)
|
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 |
ChunkedInputStream
public ChunkedInputStream(java.io.InputStream in,
HttpMethod method)
throws java.io.IOException
- Parameters:
in
- must be non-nullmethod
- must be non-null
- Throws:
java.io.IOException
java.lang.NullPointerException
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.
Footers are read automcatically at the end of the stream and can be obtained
with the getFooters() 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
read
public int read(byte[] b,
int off,
int len)
throws java.io.IOException
- Overrides:
read
in class java.io.InputStream
java.io.IOException
read
public int read(byte[] b)
throws java.io.IOException
- Overrides:
read
in class java.io.InputStream
java.io.IOException
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.
- Overrides:
close
in class java.io.InputStream
java.io.IOException
Copyright © 2001-2003 Apache Software Foundation. All Rights Reserved.