public class BoundedInputStream extends FilterInputStream
This is useful to wrap ServletInputStreams. The ServletInputStream will block if you try to read content from it that isn't there, because it doesn't know whether the content hasn't arrived yet or whether the content has finished. So, one of these, initialized with the Content-length sent in the ServletInputStream's header, will stop it blocking, providing it's been sent with a correct content length.
in
Constructor and Description |
---|
BoundedInputStream(InputStream in)
Constructs a new
BoundedInputStream that wraps the given input
stream and is unlimited. |
BoundedInputStream(InputStream inputStream,
long maxLength)
Constructs a new
BoundedInputStream that wraps the given input
stream and limits it to a certain size. |
Modifier and Type | Method and Description |
---|---|
int |
available() |
void |
close()
|
long |
getCount()
Gets the count of bytes read.
|
long |
getMaxLength()
Gets the max count of bytes to read.
|
boolean |
isPropagateClose()
Tests whether the
close() method
should propagate to the underling InputStream . |
void |
mark(int readlimit)
Invokes the delegate's
mark(int) method. |
boolean |
markSupported()
Invokes the delegate's
markSupported() method. |
protected void |
onMaxLength(long maxLength,
long count)
A caller has caused a request that would cross the
maxLength boundary. |
int |
read()
Invokes the delegate's
read() method if
the current position is less than the limit. |
int |
read(byte[] b)
Invokes the delegate's
read(byte[]) method. |
int |
read(byte[] b,
int off,
int len)
Invokes the delegate's
read(byte[], int, int) method. |
void |
reset()
Invokes the delegate's
reset() method. |
void |
setPropagateClose(boolean propagateClose)
Sets whether the
close() method
should propagate to the underling InputStream . |
long |
skip(long n)
Invokes the delegate's
skip(long) method. |
String |
toString()
Invokes the delegate's
toString() method. |
public BoundedInputStream(InputStream in)
BoundedInputStream
that wraps the given input
stream and is unlimited.in
- The wrapped input stream.public BoundedInputStream(InputStream inputStream, long maxLength)
BoundedInputStream
that wraps the given input
stream and limits it to a certain size.inputStream
- The wrapped input stream.maxLength
- The maximum number of bytes to return.public int available() throws IOException
available
in class FilterInputStream
IOException
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class FilterInputStream
IOException
- if an I/O error occurs.public long getCount()
public long getMaxLength()
public boolean isPropagateClose()
close()
method
should propagate to the underling InputStream
.true
if calling close()
propagates to the close()
method of the
underlying stream or false
if it does not.public void mark(int readlimit)
mark(int)
method.mark
in class FilterInputStream
readlimit
- read ahead limitpublic boolean markSupported()
markSupported()
method.markSupported
in class FilterInputStream
protected void onMaxLength(long maxLength, long count) throws IOException
maxLength
boundary.maxLength
- The max count of bytes to read.count
- The count of bytes read.IOException
- Subclasses may throw.public int read() throws IOException
read()
method if
the current position is less than the limit.read
in class FilterInputStream
IOException
- if an I/O error occurs.public int read(byte[] b) throws IOException
read(byte[])
method.read
in class FilterInputStream
b
- the buffer to read the bytes intoIOException
- if an I/O error occurs.public int read(byte[] b, int off, int len) throws IOException
read(byte[], int, int)
method.read
in class FilterInputStream
b
- the buffer to read the bytes intooff
- The start offsetlen
- The number of bytes to readIOException
- if an I/O error occurs.public void reset() throws IOException
reset()
method.reset
in class FilterInputStream
IOException
- if an I/O error occurs.public void setPropagateClose(boolean propagateClose)
close()
method
should propagate to the underling InputStream
.propagateClose
- true
if calling
close()
propagates to the close()
method of the underlying stream or
false
if it does not.public long skip(long n) throws IOException
skip(long)
method.skip
in class FilterInputStream
n
- the number of bytes to skipIOException
- if an I/O error occurs.Copyright © 2002–2023 The Apache Software Foundation. All rights reserved.