Package software.amazon.awssdk.core.internal.async

Class ByteArrayAsyncResponseTransformer<ResponseT>

java.lang.Object

software.amazon.awssdk.core.internal.async.ByteArrayAsyncResponseTransformer<ResponseT>

Type Parameters:

ResponseT - Pojo response type.

All Implemented Interfaces:

AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

@SdkInternalApi
public final class ByteArrayAsyncResponseTransformer<ResponseT>
extends Object
implements AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Implementation of AsyncResponseTransformer that dumps content into a byte array and supports further conversions into types, like strings. This can be created with static methods on AsyncResponseTransformer.

See Also:

AsyncResponseTransformer.toBytes()

Nested Class Summary

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

AsyncResponseTransformer.SplitResult<ResponseT,ResultT>, AsyncResponseTransformer.TransformerType

Constructor Summary

Constructors

Constructor	Description
ByteArrayAsyncResponseTransformer()

Method Summary

Modifier and Type	Method	Description
void	exceptionOccurred(Throwable throwable)	Called when an error is encountered while making the request or receiving the response.
String	name()	Each AsyncResponseTransformer should return a well-formed name that can be used to identify the implementation.
void	onResponse(ResponseT response)	Called when the unmarshalled response object is ready.
void	onStream(SdkPublisher<ByteBuffer> publisher)	Called when the response stream is ready.
CompletableFuture<ResponseBytes<ResponseT>>	prepare()	Initial call to enable any setup required before the response is handled.
AsyncResponseTransformer.SplitResult<ResponseT,ResponseBytes<ResponseT>>	split(SplittingTransformerConfiguration splitConfig)	Creates an AsyncResponseTransformer.SplitResult which contains an SplittingTransformer that splits the AsyncResponseTransformer into multiple ones, publishing them as a SdkPublisher.

Methods inherited from class java.lang.Object

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

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

split

Constructor Detail

ByteArrayAsyncResponseTransformer

public ByteArrayAsyncResponseTransformer()

Method Detail

prepare

public CompletableFuture<ResponseBytes<ResponseT>> prepare()

Description copied from interface: AsyncResponseTransformer

Initial call to enable any setup required before the response is handled.

Note that this will be called for each request attempt, up to the number of retries allowed by the configured RetryPolicy.

This method is guaranteed to be called before the request is executed, and before AsyncResponseTransformer.onResponse(Object) is signaled.

Specified by:

prepare in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Returns:

The future holding the transformed response.

onResponse

public void onResponse(ResponseT response)

Description copied from interface: AsyncResponseTransformer

Called when the unmarshalled response object is ready.

Specified by:

onResponse in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Parameters:

response - The unmarshalled response.

onStream

public void onStream(SdkPublisher<ByteBuffer> publisher)

Description copied from interface: AsyncResponseTransformer

Called when the response stream is ready.

Specified by:

onStream in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Parameters:

publisher - The publisher.

exceptionOccurred

public void exceptionOccurred(Throwable throwable)

Description copied from interface: AsyncResponseTransformer

Called when an error is encountered while making the request or receiving the response. Implementations should free up any resources in this method. This method may be called multiple times during the lifecycle of a request if automatic retries are enabled.

Specified by:

exceptionOccurred in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Parameters:

throwable - Error that occurred.

split

public AsyncResponseTransformer.SplitResult<ResponseT,ResponseBytes<ResponseT>> split(SplittingTransformerConfiguration splitConfig)

Description copied from interface: AsyncResponseTransformer

Creates an AsyncResponseTransformer.SplitResult which contains an SplittingTransformer that splits the AsyncResponseTransformer into multiple ones, publishing them as a SdkPublisher.

Specified by:

split in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Parameters:

splitConfig - configuration for the split transformer

Returns:

SplitAsyncResponseTransformer instance.

See Also:

SplittingTransformer, AsyncResponseTransformer.SplitResult

name

public String name()

Description copied from interface: AsyncResponseTransformer

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

Specified by:

name in interface AsyncResponseTransformer<ResponseT,ResponseBytes<ResponseT>>

Returns:

String containing the identifying name of this AsyncRequestTransformer.