Package io.micronaut.http.body

Interface ByteBodyFactory.BufferingOutputStream

All Superinterfaces:

AutoCloseable, Closeable

Enclosing class:

ByteBodyFactory

public static interface ByteBodyFactory.BufferingOutputStream
extends Closeable

Wrapper around a OutputStream that buffers into a CloseableAvailableByteBody. Must be closed after use, even if finishBuffer() has not been called (e.g. on error), to avoid resource leaks.

Since:

4.10.0

Method Summary

Modifier and Type	Method	Description
void	close()	Close this buffer.
@NonNull CloseableAvailableByteBody	finishBuffer()	Finalize this buffer, returning it as a CloseableAvailableByteBody.
@NonNull OutputStream	stream()	Get the stream you can write to.

Method Details

stream

@NonNull
@NonNull OutputStream stream()
                      throws IllegalStateException

Get the stream you can write to.

Returns:

The OutputStream

Throws:

IllegalStateException - If the buffer has already been finalized

finishBuffer

@NonNull
@NonNull CloseableAvailableByteBody finishBuffer()
                                          throws IOException,
IllegalStateException

Finalize this buffer, returning it as a CloseableAvailableByteBody. This method can only be called once. Release ownership of the buffer transfers to the caller: Closing this ByteBodyFactory.BufferingOutputStream after this method has been called will not close the returned CloseableAvailableByteBody.

Returns:

The finished buffer

Throws:

IOException - If there was an exception finishing up the buffer

IllegalStateException - If this method has already been called

close

void close()
    throws IOException

Close this buffer. finishBuffer() cannot be called after this method. If it has not been called yet, the content of this buffer will be discarded.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If there was an exception finishing up the buffer