Package io.micronaut.http.body.stream

Class AvailableByteArrayBody

java.lang.Object

io.micronaut.http.body.InternalByteBody

io.micronaut.http.body.stream.AvailableByteArrayBody

All Implemented Interfaces:

AvailableByteBody, ByteBody, CloseableAvailableByteBody, CloseableByteBody, Closeable, AutoCloseable

public final class AvailableByteArrayBody
extends InternalByteBody
implements CloseableAvailableByteBody

AvailableByteBody implementation based on a simple byte array.

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 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 AvailableByteArrayBody	create(@NonNull ByteBufferFactory<?,?> bufferFactory, byte @NonNull [] array)	Deprecated. Construct through ByteBodyFactory instead
static @NonNull AvailableByteArrayBody	create(@NonNull ReadBuffer readBuffer)
long	length()	The length in bytes of the body.
@NonNull CloseableAvailableByteBody	move()	Create a new CloseableByteBody with the same content but an independent lifecycle, claiming this body in the process.
ReadBuffer	peek()
@NonNull CloseableAvailableByteBody	split()	For immediate buffers, backpressure is not relevant, so the backpressure modes passed to AvailableByteBody.split(SplitBackpressureMode) are ignored.
byte @NonNull []	toByteArray()	Get this body as a byte array.
@NonNull ReadBuffer	toReadBuffer()	Get this body as a ReadBuffer.
@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, toByteArrayPublisher

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.AvailableByteBody

expectedLength, split, toByteArrayPublisher, toByteBuffer, toByteBufferPublisher, toInputStream, toString

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

buffer, touch

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

allowDiscard

Method Details

create

@Deprecated
@NonNull
public static @NonNull AvailableByteArrayBody create(@NonNull
 @NonNull ByteBufferFactory<?,?> bufferFactory,
 byte @NonNull [] array)

Deprecated.

Construct through ByteBodyFactory instead

Creates a new AvailableByteArrayBody instance.

Parameters:

bufferFactory - the ByteBufferFactory to use for creating buffers

array - the byte array to wrap

Returns:

a new AvailableByteArrayBody instance

create

@NonNull
public static @NonNull AvailableByteArrayBody create(@NonNull
 @NonNull ReadBuffer readBuffer)

split

@NonNull
public @NonNull CloseableAvailableByteBody split()

Description copied from interface: AvailableByteBody

For immediate buffers, backpressure is not relevant, so the backpressure modes passed to AvailableByteBody.split(SplitBackpressureMode) are ignored. You can use this method always.

Specified by:

split in interface AvailableByteBody

Specified by:

split in interface ByteBody

Returns:

A body with the same content as this one

See Also:

• ByteBody.split()

length

public long length()

Description copied from interface: AvailableByteBody

The length in bytes of the body.

Specified by:

length in interface AvailableByteBody

Returns:

The length

See Also:

• ByteBody.expectedLength()

toByteArray

public byte @NonNull [] toByteArray()

Description copied from interface: AvailableByteBody

Get this body as a byte array.

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

Specified by:

toByteArray in interface AvailableByteBody

Returns:

The bytes

toReadBuffer

@NonNull
public @NonNull ReadBuffer toReadBuffer()

Description copied from interface: AvailableByteBody

Get this body as a ReadBuffer.

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

Specified by:

toReadBuffer in interface AvailableByteBody

Returns:

The 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 AvailableByteBody

Specified by:

toReadBufferPublisher in interface ByteBody

Specified by:

toReadBufferPublisher in class InternalByteBody

Returns:

The streamed bytes

move

@NonNull
public @NonNull CloseableAvailableByteBody 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.

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

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

peek

@Internal
public ReadBuffer peek()