Class FileAsyncRequestBody

java.lang.Object

software.amazon.awssdk.core.internal.async.FileAsyncRequestBody

All Implemented Interfaces:

org.reactivestreams.Publisher<ByteBuffer>, AsyncRequestBody, SdkPublisher<ByteBuffer>

@SdkInternalApi
public final class FileAsyncRequestBody
extends Object
implements AsyncRequestBody

Implementation of AsyncRequestBody that reads data from a file.

See Also:

• AsyncRequestBody.fromFile(Path)
• AsyncRequestBody.fromFile(java.io.File)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileAsyncRequestBody.Builder	A builder for FileAsyncRequestBody.

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.
static FileAsyncRequestBody.Builder	builder()
int	chunkSizeInBytes()
Optional<Long>	contentLength()
String	contentType()
long	fileLength()
FileTime	modifiedTimeAtStart()
long	numBytesToRead()
Path	path()
long	position()
Long	sizeAtStart()
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> s)

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

split

public SdkPublisher<AsyncRequestBody> split(AsyncRequestBodySplitConfiguration splitConfiguration)

Description copied from interface: AsyncRequestBody

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.

Specified by:

split in interface AsyncRequestBody

splitCloseable

public SdkPublisher<CloseableAsyncRequestBody> splitCloseable(AsyncRequestBodySplitConfiguration splitConfiguration)

Description copied from interface: AsyncRequestBody

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.

Specified by:

splitCloseable in interface AsyncRequestBody

See Also:

• AsyncRequestBody.splitCloseable(Consumer)
• AsyncRequestBodySplitConfiguration

path

public Path path()

fileLength

public long fileLength()

chunkSizeInBytes

public int chunkSizeInBytes()

position

public long position()

numBytesToRead

public long numBytesToRead()

modifiedTimeAtStart

public FileTime modifiedTimeAtStart()

sizeAtStart

public Long sizeAtStart()

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> s)

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.

builder

public static FileAsyncRequestBody.Builder builder()

Returns:

Builder instance to construct a FileAsyncRequestBody.