Package software.amazon.awssdk.services.sqs.internal.batchmanager

Class RequestBatchManager<RequestT,ResponseT,BatchResponseT>

java.lang.Object

software.amazon.awssdk.services.sqs.internal.batchmanager.RequestBatchManager<RequestT,ResponseT,BatchResponseT>

Direct Known Subclasses:

ChangeMessageVisibilityBatchManager, DeleteMessageBatchManager, SendMessageBatchManager

@SdkInternalApi
public abstract class RequestBatchManager<RequestT,ResponseT,BatchResponseT>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final RequestBatchConfiguration	batchConfiguration
static final Consumer<AwsRequestOverrideConfiguration.Builder>	USER_AGENT_APPLIER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestBatchManager(RequestBatchConfiguration overrideConfiguration, ScheduledExecutorService scheduledExecutor)

Method Summary

Modifier and Type	Method	Description
protected abstract CompletableFuture<BatchResponseT>	batchAndSend(List<IdentifiableMessage<RequestT>> identifiedRequests, String batchKey)
CompletableFuture<ResponseT>	batchRequest(RequestT request)
protected void	cancelPending()	Phase 2 of shutdown.
protected CompletableFuture<Void>	closeAndDispatch()	Phase 1 of shutdown, non-blocking.
protected abstract String	getBatchKey(RequestT request)
protected abstract List<Either<IdentifiableMessage<ResponseT>,IdentifiableMessage<Throwable>>>	mapBatchResponse(BatchResponseT batchResponse)
protected Duration	shutdownTimeout()

Methods inherited from class java.lang.Object

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

Field Details

USER_AGENT_APPLIER

public static final Consumer<AwsRequestOverrideConfiguration.Builder> USER_AGENT_APPLIER

batchConfiguration

protected final RequestBatchConfiguration batchConfiguration

Constructor Details

RequestBatchManager

protected RequestBatchManager(RequestBatchConfiguration overrideConfiguration,
 ScheduledExecutorService scheduledExecutor)

Method Details

batchRequest

public CompletableFuture<ResponseT> batchRequest(RequestT request)

batchAndSend

protected abstract CompletableFuture<BatchResponseT> batchAndSend(List<IdentifiableMessage<RequestT>> identifiedRequests,
 String batchKey)

getBatchKey

protected abstract String getBatchKey(RequestT request)

mapBatchResponse

protected abstract List<Either<IdentifiableMessage<ResponseT>,IdentifiableMessage<Throwable>>> mapBatchResponse(BatchResponseT batchResponse)

closeAndDispatch

protected CompletableFuture<Void> closeAndDispatch()

Phase 1 of shutdown, non-blocking. Marks the manager closed, dispatches every buffered batch (each exactly once), and returns a future that completes when all in-flight sends dispatched here have completed, so the caller can wait on it. Does not block and does not cancel; a second call is a no-op that returns an already-completed future.

cancelPending

protected void cancelPending()

Phase 2 of shutdown. Cancels any requests still pending after the timeout, surfacing CancellationException to their callers, and releases the buffers. Idempotent.

shutdownTimeout

protected Duration shutdownTimeout()