Class ByteBuffersAsyncRequestBody

java.lang.Object

software.amazon.awssdk.core.internal.async.ByteBuffersAsyncRequestBody

All Implemented Interfaces:

AutoCloseable, org.reactivestreams.Publisher<ByteBuffer>, AsyncRequestBody, CloseableAsyncRequestBody, SdkPublisher<ByteBuffer>, SdkAutoCloseable

@SdkInternalApi
public final class ByteBuffersAsyncRequestBody
extends Object
implements CloseableAsyncRequestBody

An implementation of AsyncRequestBody for providing data from the supplied ByteBuffer array. This is created using static methods on AsyncRequestBody

Subscription Behavior:

• Each subscriber receives a read-only view of the buffered data
• Subscribers receive data independently based on their own demand signaling
• If the body is closed, new subscribers will receive an error immediately

Resource Management:

The body should be closed when no longer needed to free buffered data and notify active subscribers. Closing the body will:

• Clear all buffered data
• Send error notifications to all active subscribers
• Prevent new subscriptions

Splitting:

Because all data is already in memory, this implementation splits into independent ByteBuffersAsyncRequestBody parts backed by read-only slices of the same data rather than using SplittingPublisher making each part replayable.

See Also:

• AsyncRequestBody.fromBytes(byte[])
• AsyncRequestBody.fromBytesUnsafe(byte[])
• AsyncRequestBody.fromByteBuffer(ByteBuffer)
• AsyncRequestBody.fromByteBufferUnsafe(ByteBuffer)
• AsyncRequestBody.fromByteBuffers(ByteBuffer...)
• AsyncRequestBody.fromByteBuffersUnsafe(ByteBuffer...)
• AsyncRequestBody.fromString(String)

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.core.async.AsyncRequestBody

AsyncRequestBody.BodyType

Method Summary

Modifier and Type	Method	Description
String	body()	Each AsyncRequestBody should return a well-formed name that can be used to identify the implementation.
List<ByteBuffer>	bufferedData()
void	close()
Optional<Long>	contentLength()
String	contentType()
static ByteBuffersAsyncRequestBody	from(byte[] bytes)
static ByteBuffersAsyncRequestBody	from(String mimetype, byte[] bytes)
static ByteBuffersAsyncRequestBody	of(Long length, ByteBuffer... buffers)
static ByteBuffersAsyncRequestBody	of(String mimetype, Long length, ByteBuffer... buffers)
static ByteBuffersAsyncRequestBody	of(String mimetype, ByteBuffer... buffers)
static ByteBuffersAsyncRequestBody	of(ByteBuffer... buffers)
static ByteBuffersAsyncRequestBody	of(List<ByteBuffer> buffers)
static ByteBuffersAsyncRequestBody	of(List<ByteBuffer> buffers, long length)
SdkPublisher<AsyncRequestBody>	split(AsyncRequestBodySplitConfiguration splitConfiguration)	Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration.
SdkPublisher<CloseableAsyncRequestBody>	splitCloseable(AsyncRequestBodySplitConfiguration splitConfiguration)	Converts this AsyncRequestBody to a publisher of CloseableAsyncRequestBodys, each of which publishes specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration.
void	subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> subscriber)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.core.async.AsyncRequestBody

split, splitCloseable

Methods inherited from interface software.amazon.awssdk.core.async.SdkPublisher

addTrailingData, buffer, doAfterOnCancel, doAfterOnComplete, doAfterOnError, filter, filter, flatMapIterable, limit, map, subscribe

Method Details

contentLength

public Optional<Long> contentLength()

Specified by:

contentLength in interface AsyncRequestBody

Returns:

The content length of the data being produced.

contentType

public String contentType()

Specified by:

contentType in interface AsyncRequestBody

Returns:

The content type of the data being produced.

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> subscriber)

Specified by:

subscribe in interface org.reactivestreams.Publisher<ByteBuffer>

body

public String body()

Description copied from interface: AsyncRequestBody

Each AsyncRequestBody should return a well-formed name that can be used to identify the implementation. The body name should only include alphanumeric characters.

Specified by:

body in interface AsyncRequestBody

Returns:

String containing the identifying name of this AsyncRequestBody implementation.

split

public SdkPublisher<AsyncRequestBody> split(AsyncRequestBodySplitConfiguration splitConfiguration)

Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration. The default chunk size is 2MB and the default buffer size is 8MB.

By default, if content length of this AsyncRequestBody is present, each divided AsyncRequestBody is delivered to the subscriber right after it's initialized. On the other hand, if content length is null, it is sent after the entire content for that chunk is buffered. In this case, the configured maxMemoryUsageInBytes must be larger than or equal to chunkSizeInBytes. Note that this behavior may be different if a specific implementation of this interface overrides this method.

Behaves the same as splitCloseable(AsyncRequestBodySplitConfiguration); the emitted parts are closeable, even though they are exposed here as plain AsyncRequestBodys.

Specified by:

split in interface AsyncRequestBody

splitCloseable

public SdkPublisher<CloseableAsyncRequestBody> splitCloseable(AsyncRequestBodySplitConfiguration splitConfiguration)

Converts this AsyncRequestBody to a publisher of CloseableAsyncRequestBodys, each of which publishes specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration. The default chunk size is 2MB and the default buffer size is 8MB.

The default implementation behaves the same as AsyncRequestBody.split(AsyncRequestBodySplitConfiguration). This behavior may vary in different implementations.

Caller is responsible for closing CloseableAsyncRequestBody when it is ready to be disposed to release any resources.

Note: This method is primarily intended for use by AWS SDK high-level libraries and internal components. SDK customers should typically use higher-level APIs provided by service clients rather than calling this method directly.

Each part is an independent, replayable ByteBuffersAsyncRequestBody backed by read-only slices of this body's data, so no data is copied and each part may be subscribed to more than once (i.e. it supports retries). Closing a part releases only that part's slices; it does not affect this body or any sibling part.

AsyncRequestBodySplitConfiguration.bufferSizeInBytes() is not applicable here and is ignored, since all of the data is already buffered in memory.

Specified by:

splitCloseable in interface AsyncRequestBody

See Also:

• AsyncRequestBody.splitCloseable(Consumer)
• AsyncRequestBodySplitConfiguration

of

public static ByteBuffersAsyncRequestBody of(List<ByteBuffer> buffers,
 long length)

of

public static ByteBuffersAsyncRequestBody of(List<ByteBuffer> buffers)

of

public static ByteBuffersAsyncRequestBody of(ByteBuffer... buffers)

of

public static ByteBuffersAsyncRequestBody of(Long length,
 ByteBuffer... buffers)

of

public static ByteBuffersAsyncRequestBody of(String mimetype,
 ByteBuffer... buffers)

of

public static ByteBuffersAsyncRequestBody of(String mimetype,
 Long length,
 ByteBuffer... buffers)

from

public static ByteBuffersAsyncRequestBody from(byte[] bytes)

from

public static ByteBuffersAsyncRequestBody from(String mimetype,
 byte[] bytes)

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

bufferedData

@SdkTestInternalApi
public List<ByteBuffer> bufferedData()