cz.ues.platform.commons.lang

Class UESLimitedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

cz.ues.platform.commons.lang.UESLimitedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class UESLimitedInputStream
extends java.io.FilterInputStream

Filter for an input stream. It limits the number of bytes that could be read from the stream. Raises an exception if the limit is exceeded. The main purpose is for the special cases, where the stream from the client is read whole to the memory. This filter limits the total number of bytes, thus limiting maximum allocated memory, therefore preventing OutOfMemoryError problems.

Field Summary

Fields

Modifier and Type	Field and Description
private long	count The current number of bytes.
private static long	DEFAULT_SIZE_LIMIT The default limit.
private long	sizeLimit The maximum size of the stream, in bytes.

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
UESLimitedInputStream(java.io.InputStream inStream) Constructs the limited input stream.
UESLimitedInputStream(java.io.InputStream inStream, long sizeLimit) Constructs the limited input stream.

Method Summary

Methods

Modifier and Type	Method and Description
private void	checkLimit() Checks if the stream size has been exceeded, throws an exception in that case.
int	read()
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SIZE_LIMIT

private static DEFAULT_SIZE_LIMIT

The default limit.

sizeLimit

private sizeLimit

The maximum size of the stream, in bytes.

count

private count

The current number of bytes.

Constructor Detail

UESLimitedInputStream

public UESLimitedInputStream(java.io.InputStream inStream)

Constructs the limited input stream. Default limit is determined by the system.

Parameters:

inStream - a stream to be limited in size

UESLimitedInputStream

public UESLimitedInputStream(java.io.InputStream inStream,
long sizeLimit)

Constructs the limited input stream.

Parameters:

inStream - a stream to be limited in size

sizeLimit - the limit

Method Detail

checkLimit

private void checkLimit()
throws java.io.IOException

Checks if the stream size has been exceeded, throws an exception in that case.

Throws:

java.io.IOException - when the stream size has been exceeded

read

public int read()
throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b,
int off,
int len)
throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException