Package io.micronaut.http.body.stream

Class InputStreamByteBody

java.lang.Object

io.micronaut.http.body.InternalByteBody

io.micronaut.http.body.stream.InputStreamByteBody

All Implemented Interfaces:

ByteBody, CloseableByteBody, Closeable, AutoCloseable

public final class InputStreamByteBody
extends InternalByteBody
implements CloseableByteBody

ByteBody implementation that reads from an InputStream.

Since:

4.6.0

Author:

Jonas Konrad

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.http.body.ByteBody

ByteBody.BodyDiscardedException, ByteBody.SplitBackpressureMode

Method Summary

Modifier and Type	Method	Description
@NonNull CloseableByteBody	allowDiscard()	Signal that the upstream may discard any remaining body data.
@NonNull ExecutionFlow<? extends CloseableAvailableByteBody>	bufferFlow()	Variant of InternalByteBody.buffer() that uses the ExecutionFlow API for extra efficiency.
void	close()	Clean up any resources held by this instance.
static @NonNull CloseableByteBody	create(@NonNull InputStream stream, @NonNull OptionalLong length, @NonNull Executor ioExecutor, @NonNull ByteBufferFactory<?,?> bufferFactory)	Deprecated. Please pass a ByteBodyFactory instead (create(InputStream, OptionalLong, Executor, ByteBodyFactory))
static @NonNull CloseableByteBody	create(@NonNull InputStream stream, @NonNull OptionalLong length, @NonNull Executor ioExecutor, @NonNull ByteBodyFactory bodyFactory)	Create a new stream-based CloseableByteBody.
@NonNull OptionalLong	expectedLength()	Get the expected length of this body, if known (either from Content-Length or from previous buffering).
@NonNull CloseableByteBody	move()	Create a new CloseableByteBody with the same content but an independent lifecycle, claiming this body in the process.
@NonNull CloseableByteBody	split(ByteBody.SplitBackpressureMode backpressureMode)	Create a new, independent ByteBody that contains the same data as this one.
@NonNull reactor.core.publisher.Flux<byte[]>	toByteArrayPublisher()	Get this body as a reactive stream of byte arrays.
@NonNull io.micronaut.http.body.stream.ExtendedInputStream	toInputStream()	Get this body as an InputStream.
@NonNull Publisher<ReadBuffer>	toReadBufferPublisher()	Get this body as a reactive stream of ReadBuffers.

Methods inherited from class io.micronaut.http.body.InternalByteBody

buffer, bufferFlow, failClaim, recordClosed, recordPrimaryOp

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.body.ByteBody

buffer, split, toByteBufferPublisher, touch

Method Details

create

@NonNull
public static @NonNull CloseableByteBody create(@NonNull
 @NonNull InputStream stream,
 @NonNull
 @NonNull OptionalLong length,
 @NonNull
 @NonNull Executor ioExecutor,
 @NonNull
 @NonNull ByteBufferFactory<?,?> bufferFactory)

Deprecated.

Please pass a ByteBodyFactory instead (create(InputStream, OptionalLong, Executor, ByteBodyFactory))

Create a new stream-based CloseableByteBody. Ownership of the stream is transferred to the returned body.

Parameters:

stream - The stream backing the body

length - The expected content length (see expectedLength())

ioExecutor - An executor where blocking InputStream.read() may be performed

bufferFactory - A ByteBufferFactory for buffer-based methods

Returns:

The body

create

@NonNull
public static @NonNull CloseableByteBody create(@NonNull
 @NonNull InputStream stream,
 @NonNull
 @NonNull OptionalLong length,
 @NonNull
 @NonNull Executor ioExecutor,
 @NonNull
 @NonNull ByteBodyFactory bodyFactory)

Create a new stream-based CloseableByteBody. Ownership of the stream is transferred to the returned body.

Parameters:

stream - The stream backing the body

length - The expected content length (see expectedLength())

ioExecutor - An executor where blocking InputStream.read() may be performed

bodyFactory - A ByteBodyFactory for buffer-based methods

Returns:

The body

allowDiscard

@NonNull
public @NonNull CloseableByteBody allowDiscard()

Description copied from interface: ByteBody

Signal that the upstream may discard any remaining body data. Only if all consumers of the body allow discarding will the body be discarded, otherwise it will still be sent to all consumers. It is an optional operation.

Discarding may be implemented e.g. by closing the input side of an HTTP/2 stream.

This method must be called before any primary operation.

Specified by:

allowDiscard in interface ByteBody

Specified by:

allowDiscard in interface CloseableByteBody

Returns:

This body

close

public void close()

Description copied from interface: CloseableByteBody

Clean up any resources held by this instance. See class documentation.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CloseableByteBody

split

@NonNull
public @NonNull CloseableByteBody split(ByteBody.SplitBackpressureMode backpressureMode)

Description copied from interface: ByteBody

Create a new, independent ByteBody that contains the same data as this one.

Specified by:

split in interface ByteBody

Parameters:

backpressureMode - How to handle backpressure between the old and new body. See ByteBody.SplitBackpressureMode documentation

Returns:

The newly split body. Must be closed by the caller, unless a terminal operation is performed on it

expectedLength

@NonNull
public @NonNull OptionalLong expectedLength()

Description copied from interface: ByteBody

Get the expected length of this body, if known (either from Content-Length or from previous buffering). The actual length will never exceed this value, though it may sometimes be lower if there is a connection error.

This value may go from OptionalLong.empty() to a known value over the lifetime of this body.

This is not a primary operation and does not modify this ByteBody.

Specified by:

expectedLength in interface ByteBody

Returns:

The expected length of this body

toInputStream

@NonNull
public @NonNull io.micronaut.http.body.stream.ExtendedInputStream toInputStream()

Description copied from interface: ByteBody

Get this body as an InputStream.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

toInputStream in interface ByteBody

Returns:

The streamed bytes

toByteArrayPublisher

@NonNull
public @NonNull reactor.core.publisher.Flux<byte[]> toByteArrayPublisher()

Description copied from interface: ByteBody

Get this body as a reactive stream of byte arrays.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

toByteArrayPublisher in interface ByteBody

Overrides:

toByteArrayPublisher in class InternalByteBody

Returns:

The streamed bytes

toReadBufferPublisher

@NonNull
public @NonNull Publisher<ReadBuffer> toReadBufferPublisher()

Description copied from interface: ByteBody

Get this body as a reactive stream of ReadBuffers. Note that the caller must take care to release the returned buffers.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

toReadBufferPublisher in interface ByteBody

Specified by:

toReadBufferPublisher in class InternalByteBody

Returns:

The streamed bytes

bufferFlow

@NonNull
public @NonNull ExecutionFlow<? extends CloseableAvailableByteBody> bufferFlow()

Description copied from class: InternalByteBody

Variant of InternalByteBody.buffer() that uses the ExecutionFlow API for extra efficiency.

Specified by:

bufferFlow in class InternalByteBody

Returns:

A flow that completes when all bytes are available

move

@NonNull
public @NonNull CloseableByteBody move()

Description copied from interface: ByteBody

Create a new CloseableByteBody with the same content but an independent lifecycle, claiming this body in the process.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

The purpose of this method is to move the data to a different component in an application, making clear that the receiving component claims ownership of the body. If the sending component then closes the original ByteBody for example, it will have no impact on the new CloseableByteBody that the receiver is working with.

Specified by:

move in interface ByteBody

Returns:

A new CloseableByteBody with the same content.