Package io.undertow.servlet.spec

Class ServletOutputStreamImpl

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

io.undertow.servlet.spec.ServletOutputStreamImpl

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ServletOutputStreamImpl
extends jakarta.servlet.ServletOutputStream

This stream essentially has two modes. When it is being used in standard blocking mode then it will buffer in the pooled buffer. If the stream is closed before the buffer is full it will set a content-length header if one has not been explicitly set.

If a content-length header was present when the stream was created then it will automatically close and flush itself once the appropriate amount of data has been written.

Once the listener has been set it goes into async mode, and writes become non blocking. Most methods have two different code paths, based on if the listener has been set or not

Once the write listener has been set operations must only be invoked on this stream from the write listener callback. Attempting to invoke from a different thread will result in an IllegalStateException.

Async listener tasks are queued in the AsyncContextImpl. At most one listener can be active at one time, which simplifies the thread safety requirements.

Author:

Stuart Douglas

Constructor Summary

Constructors

Constructor	Description
ServletOutputStreamImpl(HttpServerExchange exchange)	Construct a new instance.
ServletOutputStreamImpl(HttpServerExchange exchange, Integer bufferSize)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
io.netty.buffer.ByteBuf	flushInternal()
long	getBytesWritten()
ServletRequestContext	getServletRequestContext()
boolean	isReady()
void	resetBuffer()
void	setBufferSize(int bufferSize)
void	setWriteListener(jakarta.servlet.WriteListener writeListener)
io.netty.buffer.ByteBuf	underlyingBuffer()
void	updateWritten(int len)
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

Constructor Details

ServletOutputStreamImpl

public ServletOutputStreamImpl(HttpServerExchange exchange)

Construct a new instance. No write timeout is configured.

Parameters:

exchange - The exchange

ServletOutputStreamImpl

public ServletOutputStreamImpl(HttpServerExchange exchange,
 Integer bufferSize)

Method Details

getBytesWritten

public long getBytesWritten()

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

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

resetBuffer

public void resetBuffer()

setBufferSize

public void setBufferSize(int bufferSize)

getServletRequestContext

public ServletRequestContext getServletRequestContext()

underlyingBuffer

public io.netty.buffer.ByteBuf underlyingBuffer()

flushInternal

public io.netty.buffer.ByteBuf flushInternal()
                                      throws IOException

Throws:

IOException

updateWritten

public void updateWritten(int len)

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