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 ByteBody

ByteBody.BodyDiscardedException, ByteBody.SplitBackpressureMode

Method Summary

Modifier and Type	Method	Description
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 AvailableByteArrayBody	create(ByteBufferFactory<?,?> bufferFactory, byte[] array)	Deprecated. Construct through ByteBodyFactory instead
static AvailableByteArrayBody	create(ReadBuffer readBuffer)
long	length()	The length in bytes of the body.
CloseableAvailableByteBody	move()	Create a new CloseableByteBody with the same content but an independent lifecycle, claiming this body in the process.
ReadBuffer	peek()
CloseableAvailableByteBody	split()	Equivalent to split(SplitBackpressureMode.SLOWEST).
byte[]	toByteArray()	Get this body as a byte array.
ReadBuffer	toReadBuffer()	Get this body as a ReadBuffer.
Publisher<ReadBuffer>	toReadBufferPublisher()	Get this body as a reactive stream of ReadBuffers.

Methods inherited from class InternalByteBody

buffer, bufferFlow, failClaim, recordClosed, recordPrimaryOp, toByteArrayPublisher

Methods inherited from class Object

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

Methods inherited from interface AvailableByteBody

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

Methods inherited from interface ByteBody

buffer, touch

Methods inherited from interface CloseableAvailableByteBody

allowDiscard

Method Details

create

@Deprecated
public static AvailableByteArrayBody create(ByteBufferFactory<?,?> bufferFactory,
 byte[] 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

public static AvailableByteArrayBody create(ReadBuffer readBuffer)

split

public CloseableAvailableByteBody split()

Description copied from interface: ByteBody

Equivalent to split(SplitBackpressureMode.SLOWEST).

Specified by:

split in interface AvailableByteBody

Specified by:

split in interface ByteBody

Returns:

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

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[] 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

public 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

public 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

public 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

public 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()