Class AsyncStreamingResponseHandler<OutputT extends SdkResponse,ReturnT>

java.lang.Object

software.amazon.awssdk.core.internal.http.async.AsyncStreamingResponseHandler<OutputT,ReturnT>

All Implemented Interfaces:

TransformingAsyncResponseHandler<ReturnT>, SdkAsyncHttpResponseHandler

public final class AsyncStreamingResponseHandler<OutputT extends SdkResponse,ReturnT>
extends Object
implements TransformingAsyncResponseHandler<ReturnT>

Response handler for asynchronous streaming operations.

Constructor Summary

Constructors

Constructor	Description
AsyncStreamingResponseHandler(AsyncResponseTransformer<OutputT,ReturnT> asyncResponseTransformer)

Method Summary

Modifier and Type	Method	Description
void	onError(Throwable error)	Called when there is an error making the request or receiving the response.
void	onHeaders(SdkHttpResponse response)	Called when the headers have been received.
void	onStream(org.reactivestreams.Publisher<ByteBuffer> publisher)	Called when the streaming body is ready.
CompletableFuture<ReturnT>	prepare()	Return the future holding the transformed response.
void	responseHandler(HttpResponseHandler<OutputT> responseHandler)

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncStreamingResponseHandler

public AsyncStreamingResponseHandler(AsyncResponseTransformer<OutputT,ReturnT> asyncResponseTransformer)

Method Details

responseHandler

public void responseHandler(HttpResponseHandler<OutputT> responseHandler)

onHeaders

public void onHeaders(SdkHttpResponse response)

Description copied from interface: SdkAsyncHttpResponseHandler

Called when the headers have been received.

Specified by:

onHeaders in interface SdkAsyncHttpResponseHandler

Parameters:

response - The headers.

onStream

public void onStream(org.reactivestreams.Publisher<ByteBuffer> publisher)

Description copied from interface: SdkAsyncHttpResponseHandler

Called when the streaming body is ready.

This method is always called. If the response does not have a body, then the publisher will complete the subscription without signalling any elements.

Specified by:

onStream in interface SdkAsyncHttpResponseHandler

Parameters:

publisher - The streaming body.

onError

public void onError(Throwable error)

Description copied from interface: SdkAsyncHttpResponseHandler

Called when there is an error making the request or receiving the response. If the error is encountered while streaming the body, then the error is also delivered to the Subscriber.

Specified by:

onError in interface SdkAsyncHttpResponseHandler

Parameters:

error - The error.

prepare

public CompletableFuture<ReturnT> prepare()

Description copied from interface: TransformingAsyncResponseHandler

Return the future holding the transformed response.

This method is guaranteed to be called before the request is executed, and before SdkAsyncHttpResponseHandler.onHeaders(software.amazon.awssdk.http.SdkHttpResponse) is signaled.

Specified by:

prepare in interface TransformingAsyncResponseHandler<OutputT extends SdkResponse>

Returns:

The future holding the transformed response.