org.nuxeo.ecm.platform.web.common.requestcontroller.filter

Class BufferingServletOutputStream

java.lang.Object

java.io.OutputStream

javax.servlet.ServletOutputStream

org.nuxeo.ecm.platform.web.common.requestcontroller.filter.BufferingServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BufferingServletOutputStream
extends javax.servlet.ServletOutputStream

A ServletOutputStream that buffers everything until stopBuffering() is called.

There may only be one such instance per thread.

Buffering is done first in memory, then on disk if the size exceeds a limit.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL Initial memory buffer size.
static int	MAX Maximum memory buffer size, after this a file is used.

Constructor Summary

Constructors

Constructor and Description
BufferingServletOutputStream(OutputStream outputStream) A ServletOutputStream wrapper that buffers everything until stopBuffering() is called.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This implementation does nothing, we still want to keep the buffer until stopBuffering() time.
void	flush() This implementation does nothing, we still want to keep buffering and not flush.
PrintWriter	getWriter()
void	stopBuffering() Writes any buffered data to the underlying OutputStream and from now on don't buffer anymore.
static void	stopBuffering(OutputStream out) Tells the given OutputStream to stop buffering (if it was).
static void	stopBufferingThread() Stop buffering the OutputStream for this thread (if it was).
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class javax.servlet.ServletOutputStream

print, print, print, print, print, print, print, println, println, println, println, println, println, println, println

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL

public static final int INITIAL

Initial memory buffer size.

See Also:

Constant Field Values

MAX

public static final int MAX

Maximum memory buffer size, after this a file is used.

See Also:

Constant Field Values

Constructor Detail

BufferingServletOutputStream

public BufferingServletOutputStream(OutputStream outputStream)

A ServletOutputStream wrapper that buffers everything until stopBuffering() is called.

stopBuffering() MUST be called in a finally statement in order for resources to be closed properly.

Parameters:

outputStream - the underlying output stream

Method Detail

getWriter

public PrintWriter getWriter()

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
         int off,
         int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

This implementation does nothing, we still want to keep buffering and not flush.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

This implementation does nothing, we still want to keep the buffer until stopBuffering() time.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

stopBuffering

public void stopBuffering()
                   throws IOException

Writes any buffered data to the underlying OutputStream and from now on don't buffer anymore.

Throws:

IOException

stopBuffering

public static void stopBuffering(OutputStream out)
                          throws IOException

Tells the given OutputStream to stop buffering (if it was).

Throws:

IOException

stopBufferingThread

public static void stopBufferingThread()
                                throws IOException

Stop buffering the OutputStream for this thread (if it was).

Throws:

IOException

Since:

5.5 (HF01)