Class LimitedInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.tomcat.util.http.fileupload.util.LimitedInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable,Closeable
An input stream, which limits its data size. This stream is
used, if the content length is unknown.
-
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionLimitedInputStream(InputStream inputStream, long pSizeMax) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes this input stream and releases any system resources associated with the stream.booleanisClosed()Returns, whether this stream is already closed.protected abstract voidraiseError(long pSizeMax, long pCount) Called to indicate, that the input streams limit has been exceeded.intread()Reads the next byte of data from this input stream.intread(byte[] b, int off, int len) Reads up tolenbytes of data from this input stream into an array of bytes.Methods inherited from class java.io.FilterInputStream
available, mark, markSupported, read, reset, skipMethods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Constructor Details
-
LimitedInputStream
Creates a new instance.- Parameters:
inputStream- The input stream, which shall be limited.pSizeMax- The limit; no more than this number of bytes shall be returned by the source stream.
-
-
Method Details
-
raiseError
Called to indicate, that the input streams limit has been exceeded.- Parameters:
pSizeMax- The input streams limit, in bytes.pCount- The actual number of bytes.- Throws:
IOException- The called method is expected to raise an IOException.
-
read
Reads the next byte of data from this input stream. The value byte is returned as anintin the range0to255. If no byte is available because the end of the stream has been reached, the value-1is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.This method simply performs
in.read()and returns the result.- Overrides:
readin classFilterInputStream- Returns:
- the next byte of data, or
-1if the end of the stream is reached. - Throws:
IOException- if an I/O error occurs.- See Also:
-
read
Reads up tolenbytes of data from this input stream into an array of bytes. Iflenis not zero, the method blocks until some input is available; otherwise, no bytes are read and0is returned.This method simply performs
in.read(b, off, len)and returns the result.- Overrides:
readin classFilterInputStream- Parameters:
b- the buffer into which the data is read.off- The start offset in the destination arrayb.len- the maximum number of bytes read.- Returns:
- the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
NullPointerException- Ifbisnull.IndexOutOfBoundsException- Ifoffis negative,lenis negative, orlenis greater thanb.length - offIOException- if an I/O error occurs.- See Also:
-
isClosed
Returns, whether this stream is already closed.- Specified by:
isClosedin interfaceCloseable- Returns:
- True, if the stream is closed, otherwise false.
- Throws:
IOException- An I/O error occurred.
-
close
Closes this input stream and releases any system resources associated with the stream. This method simply performsin.close().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterInputStream- Throws:
IOException- if an I/O error occurs.- See Also:
-