public class ContentLengthInputStream extends InputStream
Content-Length header
.
Entities transferred using this stream can be maximum Long.MAX_VALUE
long.
Note that this class NEVER closes the underlying stream, even when
close()
gets called. Instead, it will read until the "end" of
its limit on close, which allows for the seamless execution of subsequent
HTTP 1.1 requests, while not requiring the client to remember to read the
entire contents of the response.
Constructor and Description |
---|
ContentLengthInputStream(SessionInputBuffer buffer,
InputStream inputStream,
long contentLength)
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
available() |
void |
close()
Reads until the end of the known length of content.
|
int |
read()
Read the next byte from the stream
|
int |
read(byte[] b)
Read more bytes from the stream.
|
int |
read(byte[] b,
int off,
int len)
Does standard
InputStream.read(byte[], int, int) behavior, but
also notifies the watcher when the contents have been consumed. |
long |
skip(long n)
Skips and discards a number of bytes from the input stream.
|
mark, markSupported, reset
public ContentLengthInputStream(SessionInputBuffer buffer, InputStream inputStream, long contentLength)
buffer
- Session input bufferinputStream
- Input streamcontentLength
- The maximum number of bytes that can be read from
the stream. Subsequent read operations will return -1.public void close() throws IOException
Reads until the end of the known length of content.
Does NOT close the underlying stream, but instead leaves it primed to parse the next response.
close
in interface Closeable
close
in interface AutoCloseable
close
in class InputStream
IOException
- If an IO problem occurs.public int available() throws IOException
available
in class InputStream
IOException
public int read() throws IOException
read
in class InputStream
IOException
- If an IO problem occursInputStream.read()
public int read(byte[] b, int off, int len) throws IOException
InputStream.read(byte[], int, int)
behavior, but
also notifies the watcher when the contents have been consumed.read
in class InputStream
b
- The byte array to fill.off
- Start filling at this position.len
- The number of bytes to attempt to read.IOException
- Should an error occur on the wrapped stream.public int read(byte[] b) throws IOException
read
in class InputStream
b
- The byte array to put the new data in.IOException
- If an IO problem occursInputStream.read(byte[])
public long skip(long n) throws IOException
skip
in class InputStream
n
- The number of bytes to skip.IOException
- If an error occurs while skipping bytes.InputStream.skip(long)
Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.