com.ibm.cos.v2.awscore.eventstream

Class EventStreamAsyncResponseTransformer<ResponseT,EventT>

java.lang.Object

com.ibm.cos.v2.awscore.eventstream.EventStreamAsyncResponseTransformer<ResponseT,EventT>

Type Parameters:

ResponseT - Initial response type of event stream operation.

EventT - Base type of event stream message frames.

All Implemented Interfaces:

AsyncResponseTransformer<SdkResponse,Void>

public final class EventStreamAsyncResponseTransformer<ResponseT,EventT>
extends Object
implements AsyncResponseTransformer<SdkResponse,Void>

Unmarshalling layer on top of the AsyncResponseTransformer to decode event stream messages and deliver them to the subscriber.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventStreamAsyncResponseTransformer.Builder<ResponseT,EventT> Builder for EventStreamAsyncResponseTransformer.

Nested classes/interfaces inherited from interface com.ibm.cos.v2.core.async.AsyncResponseTransformer

AsyncResponseTransformer.SplitResult<ResponseT,ResultT>

Method Summary

Modifier and Type	Method and Description
static <ResponseT,EventT> EventStreamAsyncResponseTransformer.Builder<ResponseT,EventT>	builder() Creates a EventStreamAsyncResponseTransformer.Builder used to create EventStreamAsyncResponseTransformer.
void	exceptionOccurred(Throwable throwable) Called when an error is encountered while making the request or receiving the response.
void	onResponse(SdkResponse response) Called when the unmarshalled response object is ready.
void	onStream(SdkPublisher<ByteBuffer> publisher) Called when the response stream is ready.
CompletableFuture<Void>	prepare() Initial call to enable any setup required before the response is handled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.core.async.AsyncResponseTransformer

split, split, toBlockingInputStream, toBytes, toFile, toFile, toFile, toFile, toFile, toFile, toPublisher

Method Detail

builder

public static <ResponseT,EventT> EventStreamAsyncResponseTransformer.Builder<ResponseT,EventT> builder()

Creates a EventStreamAsyncResponseTransformer.Builder used to create EventStreamAsyncResponseTransformer.

Type Parameters:

ResponseT - Initial response type.

EventT - Event type being delivered.

Returns:

New EventStreamAsyncResponseTransformer.Builder instance.

prepare

public CompletableFuture<Void> 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<SdkResponse,Void>

Returns:

The future holding the transformed response.

onResponse

public void onResponse(SdkResponse response)

Description copied from interface: AsyncResponseTransformer

Called when the unmarshalled response object is ready.

Specified by:

onResponse in interface AsyncResponseTransformer<SdkResponse,Void>

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<SdkResponse,Void>

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<SdkResponse,Void>

Parameters:

throwable - Error that occurred.