Package io.micronaut.http.body

Interface AvailableByteBody

All Superinterfaces:

ByteBody

All Known Subinterfaces:

CloseableAvailableByteBody

All Known Implementing Classes:

AvailableByteArrayBody, AvailableNettyByteBody

public interface AvailableByteBody
extends ByteBody

This is an extension of ByteBody when the entire body is immediately available (without waiting). It has the same semantics as ByteBody, but it adds a few other primary operations for convenience.

Since:

4.5.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
default @NonNull AvailableByteBody	allowDiscard()	Deprecated. This method is unnecessary for AvailableByteBody, it does nothing.
default @NonNull OptionalLong	expectedLength()	Deprecated. This method is unnecessary for AvailableByteBody.
long	length()	The length in bytes of the body.
@NonNull CloseableAvailableByteBody	split()	For immediate buffers, backpressure is not relevant, so the backpressure modes passed to split(SplitBackpressureMode) are ignored.
default @NonNull CloseableAvailableByteBody	split(@NonNull ByteBody.SplitBackpressureMode backpressureMode)	Deprecated. This method is unnecessary for AvailableByteBody.
byte @NonNull []	toByteArray()	Get this body as a byte array.
default @NonNull Publisher<byte[]>	toByteArrayPublisher()	Deprecated. This method is unnecessary for AvailableByteBody.
@NonNull ByteBuffer<?>	toByteBuffer()	Get this body as a ByteBuffer.
default @NonNull Publisher<ByteBuffer<?>>	toByteBufferPublisher()	Deprecated. This method is unnecessary for AvailableByteBody.
default @NonNull String	toString(@NonNull Charset charset)	Convert this body to a string with the given charset.

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

buffer, toInputStream

Method Details

split

@NonNull
@NonNull CloseableAvailableByteBody split()

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

Specified by:

split in interface ByteBody

Returns:

A body with the same content as this one

See Also:

• ByteBody.split()

split

@Deprecated
@NonNull
default @NonNull CloseableAvailableByteBody split(@NonNull
 @NonNull ByteBody.SplitBackpressureMode backpressureMode)

Deprecated.

This method is unnecessary for AvailableByteBody. Use split() directly.

This method is equivalent to split(), the backpressure parameter is ignored.

Specified by:

split in interface ByteBody

Parameters:

backpressureMode - ignored

Returns:

A body with the same content as this one

allowDiscard

@NonNull
@Deprecated
default @NonNull AvailableByteBody allowDiscard()

Deprecated.

This method is unnecessary for AvailableByteBody, it does nothing.

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

Returns:

This body

length

long length()

The length in bytes of the body.

Returns:

The length

See Also:

• ByteBody.expectedLength()

expectedLength

@NonNull
@Deprecated
default @NonNull OptionalLong expectedLength()

Deprecated.

This method is unnecessary for AvailableByteBody. Use length() directly.

The length in bytes of the body. Never returns OptionalLong.empty() for AvailableByteBody. Use length() directly instead.

Specified by:

expectedLength in interface ByteBody

Returns:

The length

toByteArray

byte @NonNull [] toByteArray()

Get this body as a byte array.

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

Returns:

The bytes

toByteBuffer

@NonNull
@NonNull ByteBuffer<?> toByteBuffer()

Get this body as a ByteBuffer. Note that the buffer may be reference counted, and the caller must take care of releasing it.

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

Returns:

The bytes

toString

@NonNull
default @NonNull String toString(@NonNull
 @NonNull Charset charset)

Convert this body to a string with the given charset.

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

Parameters:

charset - The charset to convert the body

Returns:

The body as a string

toByteBufferPublisher

@NonNull
@Deprecated
default @NonNull Publisher<ByteBuffer<?>> toByteBufferPublisher()

Deprecated.

This method is unnecessary for AvailableByteBody. Use toByteBuffer() directly.

Get this body as a reactive stream of ByteBuffers. Note that the buffers may be reference counted, and the caller must take care of releasing them.

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

Specified by:

toByteBufferPublisher in interface ByteBody

Returns:

The streamed bytes

toByteArrayPublisher

@NonNull
@Deprecated
default @NonNull Publisher<byte[]> toByteArrayPublisher()

Deprecated.

This method is unnecessary for AvailableByteBody. Use toByteArray() directly.

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

Returns:

The streamed bytes