Package io.awspring.cloud.sqs.listener.backpressure

Class BackPressureHandlerFactories

java.lang.Object

io.awspring.cloud.sqs.listener.backpressure.BackPressureHandlerFactories

public class BackPressureHandlerFactories
extends Object

Utility class for creating BackPressureHandlerFactory instances used to apply back pressure strategies in SQS listener containers.

The factories provided by this class can be passed to ContainerOptions during container configuration.

Example usage:

 factory.configure(options -> options.maxConcurrentMessages(100).maxDelayBetweenPolls(Duration.ofSeconds(1))
 		.maxMessagesPerPoll(8)
 		.backPressureHandlerFactory(BackPressureHandlerFactories.concurrencyLimiterBackPressureHandler()));
 

The BackPressureMode setting in ContainerOptions is only used when using adaptiveThroughputBackPressureHandler(). If you're passing a specific factory such as concurrencyLimiterBackPressureHandler(), the mode will be ignored.

The following ContainerOptions properties are used by the built-in back pressure handler implementations:

• ConcurrencyLimiterBlockingBackPressureHandler
  • maxConcurrentMessages
  • maxMessagesPerPoll
  • maxDelayBetweenPolls
• ThroughputBackPressureHandler
  • maxMessagesPerPoll
• FullBatchBackPressureHandler
  • maxMessagesPerPoll

For advanced scenarios, multiple handlers can be combined using compositeBackPressureHandler(List) or compositeBackPressureHandler(BackPressureHandlerFactory...).

Since:

4.0.0

Author:

Loïc Rouchon, Tomaz Fernandes

Method Summary

Modifier and Type	Method	Description
static BackPressureHandlerFactory	adaptiveThroughputBackPressureHandler()	Creates a factory for an adaptive BackPressureHandler, combining different strategies based on the provided ContainerOptions and its configured BackPressureMode.
static BackPressureHandlerFactory	compositeBackPressureHandler(BackPressureHandlerFactory... backPressureHandlerFactories)	Creates a new CompositeBackPressureHandler from the given array of BackPressureHandlerFactory instances.
static BackPressureHandlerFactory	compositeBackPressureHandler(List<BackPressureHandlerFactory> factories)	Creates a new CompositeBackPressureHandler from the given list of BackPressureHandlerFactory instances.
static BackPressureHandlerFactory	concurrencyLimiterBackPressureHandler()	Creates a new ConcurrencyLimiterBlockingBackPressureHandler using the provided ContainerOptions.
static BackPressureHandlerFactory	fullBatchBackPressureHandler()	Creates a new FullBatchBackPressureHandler using the provided ContainerOptions.
static BackPressureHandlerFactory	semaphoreBackPressureHandler()	Deprecated.
static BackPressureHandlerFactory	throughputBackPressureHandler()	Creates a new ThroughputBackPressureHandler using the provided ContainerOptions.

Methods inherited from class java.lang.Object

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

Method Details

adaptiveThroughputBackPressureHandler

public static BackPressureHandlerFactory adaptiveThroughputBackPressureHandler()

Creates a factory for an adaptive BackPressureHandler, combining different strategies based on the provided ContainerOptions and its configured BackPressureMode.

This factory dynamically builds a composite handler using one or more of the following:

• ConcurrencyLimiterBlockingBackPressureHandler
• ThroughputBackPressureHandler
• FullBatchBackPressureHandler

The resulting behavior is similar to the original SemaphoreBackpressureHandler in previous versions.

This is the only built-in factory that makes use of BackPressureMode. If you use a specific factory such as concurrencyLimiterBackPressureHandler() the mode is not consulted.

This is the default BackPressureHandlerFactory used by listener containers.

Returns:

a BackPressureHandlerFactory producing adaptive handlers.

compositeBackPressureHandler

public static BackPressureHandlerFactory compositeBackPressureHandler(BackPressureHandlerFactory... backPressureHandlerFactories)

Creates a new CompositeBackPressureHandler from the given array of BackPressureHandlerFactory instances.

Parameters:

backPressureHandlerFactories - the factories to compose.

Returns:

a BackPressureHandlerFactory producing a composite handler.

compositeBackPressureHandler

public static BackPressureHandlerFactory compositeBackPressureHandler(List<BackPressureHandlerFactory> factories)

Creates a new CompositeBackPressureHandler from the given list of BackPressureHandlerFactory instances.

Parameters:

factories - the list of factories to compose.

Returns:

a BackPressureHandlerFactory producing a composite handler.

concurrencyLimiterBackPressureHandler

public static BackPressureHandlerFactory concurrencyLimiterBackPressureHandler()

Creates a new ConcurrencyLimiterBlockingBackPressureHandler using the provided ContainerOptions.

Returns:

a BackPressureHandlerFactory producing a concurrency-limiting handler.

throughputBackPressureHandler

public static BackPressureHandlerFactory throughputBackPressureHandler()

Creates a new ThroughputBackPressureHandler using the provided ContainerOptions.

Returns:

a BackPressureHandlerFactory producing a throughput-adaptive handler.

fullBatchBackPressureHandler

public static BackPressureHandlerFactory fullBatchBackPressureHandler()

Creates a new FullBatchBackPressureHandler using the provided ContainerOptions.

Returns:

a BackPressureHandlerFactory producing a full-batch enforcing handler.

semaphoreBackPressureHandler

@Deprecated
public static BackPressureHandlerFactory semaphoreBackPressureHandler()

Deprecated.

Creates a new SemaphoreBackPressureHandler instance based on the provided ContainerOptions.

Returns:

the created SemaphoreBackPressureHandler.