Package org.jboss.resteasy.plugins.server.servlet

Class HttpServletResponseWrapper.DeferredOutputStream

java.lang.Object

java.io.OutputStream

org.jboss.resteasy.spi.AsyncOutputStream

org.jboss.resteasy.plugins.server.servlet.HttpServletResponseWrapper.DeferredOutputStream

All Implemented Interfaces:

WriteListener, Closeable, Flushable, AutoCloseable, EventListener

Enclosing class:

HttpServletResponseWrapper

protected class HttpServletResponseWrapper.DeferredOutputStream
extends AsyncOutputStream
implements WriteListener

RESTEASY-684 wants to defer access to outputstream until a write happens

Note that all locking is on this and should remain that way to avoid deadlocks on consumers of this stream.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	asyncFlush()	Flushes this async output stream.
CompletionStage<Void>	asyncWrite(byte[] bytes, int offset, int length)	Writes to this async output stream.
void	close()
void	flush()
void	onError(Throwable t)	Invoked when an error occurs writing data using the non-blocking APIs.
void	onWritePossible()	When an instance of the WriteListener is registered with a ServletOutputStream, this method will be invoked by the container the first time when it is possible to write data.
void	write(byte[] bytes)
void	write(byte[] bytes, int i, int i1)
void	write(int i)

Methods inherited from class org.jboss.resteasy.spi.AsyncOutputStream

asyncWrite

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

Method Detail

write

public void write(int i)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
                  int i,
                  int i1)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

asyncFlush

public CompletionStage<Void> asyncFlush()

Description copied from class: AsyncOutputStream

Flushes this async output stream.

Specified by:

asyncFlush in class AsyncOutputStream

Returns:

a CompletionStage notified on completion of the flush operation.

asyncWrite

public CompletionStage<Void> asyncWrite(byte[] bytes,
                                        int offset,
                                        int length)

Description copied from class: AsyncOutputStream

Writes to this async output stream.

Specified by:

asyncWrite in class AsyncOutputStream

Parameters:

bytes - the bytes to write

offset - the offset from which to start writing in the given byte array.

length - the number of bytes to write from the given byte array

Returns:

a CompletionStage notified on completion of the write operation.

onWritePossible

public void onWritePossible()

Description copied from interface: WriteListener

When an instance of the WriteListener is registered with a ServletOutputStream, this method will be invoked by the container the first time when it is possible to write data. Subsequently the container will invoke this method if and only if the ServletOutputStream.isReady() method has been called and has returned a value of false and a write operation has subsequently become possible.

Specified by:

onWritePossible in interface WriteListener

onError

public void onError(Throwable t)

Description copied from interface: WriteListener

Invoked when an error occurs writing data using the non-blocking APIs.

Specified by:

onError in interface WriteListener

Parameters:

t - the throwable to indicate why the write operation failed