Package org.nuxeo.ecm.core.io.download

Class BufferingServletOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

org.nuxeo.ecm.core.io.download.BufferingServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BufferingServletOutputStream
extends jakarta.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	Description
protected OutputStream	file
static final int	INITIAL	Initial memory buffer size.
static final int	MAX	Maximum memory buffer size, after this a file is used.
protected ByteArrayOutputStream	memory
protected boolean	needsClose
protected boolean	needsFlush
protected final jakarta.servlet.ServletOutputStream	outputStream
protected boolean	streaming	Have we stopped buffering to pass writes directly to the output stream.
protected File	tmp
protected PrintWriter	writer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	This implementation does nothing, we still want to keep the buffer until stopBuffering() time.
protected void	createTempFile()
void	flush()	This implementation does nothing, we still want to keep buffering and not flush.
protected OutputStream	getOutputStream(int len)	Finds the proper output stream where we can write len bytes.
PrintWriter	getWriter()
boolean	isCommitted()
boolean	isReady()
void	resetBuffer()
void	setWriteListener(jakarta.servlet.WriteListener writeListener)
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).
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class jakarta.servlet.ServletOutputStream

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

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

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

streaming

protected boolean streaming

Have we stopped buffering to pass writes directly to the output stream.

needsFlush

protected boolean needsFlush

needsClose

protected boolean needsClose

outputStream

protected final jakarta.servlet.ServletOutputStream outputStream

writer

protected PrintWriter writer

memory

protected ByteArrayOutputStream memory

file

protected OutputStream file

tmp

protected File tmp

Constructor Details

BufferingServletOutputStream

public BufferingServletOutputStream(jakarta.servlet.ServletOutputStream 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 Details

getWriter

public PrintWriter getWriter()

getOutputStream

protected OutputStream getOutputStream(int len)
                                throws IOException

Finds the proper output stream where we can write len bytes.

Throws:

IOException

createTempFile

protected void createTempFile()
                       throws IOException

Throws:

IOException

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 AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

isCommitted

public boolean isCommitted()

Since:

11.5

resetBuffer

public void resetBuffer()

Since:

11.5

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

isReady

public boolean isReady()

Specified by:

isReady in class jakarta.servlet.ServletOutputStream

setWriteListener

public void setWriteListener(jakarta.servlet.WriteListener writeListener)

Specified by:

setWriteListener in class jakarta.servlet.ServletOutputStream