cz.ues.platform.commons.lang

Class UESLimitedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

cz.ues.platform.commons.lang.UESLimitedOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class UESLimitedOutputStream
extends java.io.FilterOutputStream

Filter for an output stream. It limits the number of bytes that could be written to 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.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
UESLimitedOutputStream(java.io.OutputStream outStream) Constructs the limited output stream.
UESLimitedOutputStream(java.io.OutputStream outStream, long sizeLimit) Constructs the limited output 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.
void	write(int b) No need to overwrite these 2 methods - all physical writes goes through write(int b), where the limit could be checked.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write

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

UESLimitedOutputStream

public UESLimitedOutputStream(java.io.OutputStream outStream)

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

Parameters:

outStream - a stream to be limited in size

UESLimitedOutputStream

public UESLimitedOutputStream(java.io.OutputStream outStream,
long sizeLimit)

Constructs the limited output stream.

Parameters:

outStream - 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

write

public void write(int b)
throws java.io.IOException

No need to overwrite these 2 methods - all physical writes goes through write(int b), where the limit could be checked.

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException