Package io.awspring.cloud.sqs.listener

Class AbstractContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

java.lang.Object

io.awspring.cloud.sqs.listener.AbstractContainerOptions<O,B>

All Implemented Interfaces:

ContainerOptions<O,B>

Direct Known Subclasses:

SqsContainerOptions

public abstract class AbstractContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>
extends Object
implements ContainerOptions<O,B>

Base implementation for ContainerOptions.

Since:

3.0

Author:

Tomaz Fernandes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractContainerOptions.Builder<B extends ContainerOptionsBuilder<B,O>,O extends ContainerOptions<O,B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContainerOptions(AbstractContainerOptions.Builder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
Duration	getAcknowledgementInterval()	Return the maximum interval between acknowledgements for batch acknowledgements.
AcknowledgementMode	getAcknowledgementMode()	Return the AcknowledgementMode for this container.
AcknowledgementOrdering	getAcknowledgementOrdering()	Return the AcknowledgementOrdering for this container.
TaskExecutor	getAcknowledgementResultTaskExecutor()	Return the TaskExecutor to be used by blocking AcknowledgementResultCallback implementations for this container.
Duration	getAcknowledgementShutdownTimeout()	Return the maximum amount of time that the container should wait for batched acknowledgements to finish before shutting down.
Integer	getAcknowledgementThreshold()	Return the threshold for triggering a batch acknowledgement.
BackPressureMode	getBackPressureMode()	Return the BackPressureMode for this container.
TaskExecutor	getComponentsTaskExecutor()	Return the TaskExecutor to be used by this container's components.
ListenerMode	getListenerMode()	Return the ListenerMode mode for this container.
Duration	getListenerShutdownTimeout()	Return the maximum amount of time that the container should wait for processing tasks to finish before shutting down.
int	getMaxConcurrentMessages()	Set the maximum concurrent messages that can be processed simultaneously for each queue.
Duration	getMaxDelayBetweenPolls()	Set the maximum time the polling thread should wait for a full batch of permits to be available before trying to acquire a partial batch if so configured.
int	getMaxMessagesPerPoll()	Return the number of messages that should be returned per poll.
MessagingMessageConverter<?>	getMessageConverter()	Return the MessagingMessageConverter for this container.
org.springframework.retry.backoff.BackOffPolicy	getPollBackOffPolicy()	Return the BackOffPolicy to be applied when polling throws an exception.
Duration	getPollTimeout()	Return the timeout for polling messages for this endpoint.
boolean	isAutoStartup()	Checks whether the container should be started automatically or manually.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.awspring.cloud.sqs.listener.ContainerOptions

configure, configure, createCopy, toBuilder

Constructor Details

AbstractContainerOptions

protected AbstractContainerOptions(AbstractContainerOptions.Builder<?,?> builder)

Method Details

getMaxConcurrentMessages

public int getMaxConcurrentMessages()

Description copied from interface: ContainerOptions

Set the maximum concurrent messages that can be processed simultaneously for each queue. Note that if acknowledgement batching is being used, the actual maximum number of messages inflight might be higher. Default is 10.

Specified by:

getMaxConcurrentMessages in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the maximum concurrent messages.

getMaxMessagesPerPoll

public int getMaxMessagesPerPoll()

Description copied from interface: ContainerOptions

Return the number of messages that should be returned per poll.

Specified by:

getMaxMessagesPerPoll in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the maximum number of messages per poll.

isAutoStartup

public boolean isAutoStartup()

Description copied from interface: ContainerOptions

Checks whether the container should be started automatically or manually. Default is true.

Specified by:

isAutoStartup in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

true if the container starts automatically, false if it should be started manually

getPollTimeout

public Duration getPollTimeout()

Description copied from interface: ContainerOptions

Return the timeout for polling messages for this endpoint.

Specified by:

getPollTimeout in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the timeout duration.

getPollBackOffPolicy

public org.springframework.retry.backoff.BackOffPolicy getPollBackOffPolicy()

Description copied from interface: ContainerOptions

Return the BackOffPolicy to be applied when polling throws an exception.

Specified by:

getPollBackOffPolicy in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the timeout duration.

getMaxDelayBetweenPolls

public Duration getMaxDelayBetweenPolls()

Description copied from interface: ContainerOptions

Set the maximum time the polling thread should wait for a full batch of permits to be available before trying to acquire a partial batch if so configured. A poll is only actually executed if at least one permit is available. Default is 10 seconds.

Specified by:

getMaxDelayBetweenPolls in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the maximum delay between polls.

See Also:

• BackPressureMode

getComponentsTaskExecutor

@Nullable
public TaskExecutor getComponentsTaskExecutor()

Description copied from interface: ContainerOptions

Return the TaskExecutor to be used by this container's components. It's shared by the MessageSink and any blocking components the container might have. Due to performance concerns, the provided executor MUST have a MessageExecutionThreadFactory. The container should have enough Threads to support the full load, including if it's shared between containers.

Specified by:

getComponentsTaskExecutor in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the task executor.

getAcknowledgementResultTaskExecutor

@Nullable
public TaskExecutor getAcknowledgementResultTaskExecutor()

Description copied from interface: ContainerOptions

Return the TaskExecutor to be used by blocking AcknowledgementResultCallback implementations for this container. Due to performance concerns, the provided executor MUST have a MessageExecutionThreadFactory. The container should have enough Threads to support the full load, including if it's shared between containers.

Specified by:

getAcknowledgementResultTaskExecutor in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the task executor.

getListenerShutdownTimeout

public Duration getListenerShutdownTimeout()

Description copied from interface: ContainerOptions

Return the maximum amount of time that the container should wait for processing tasks to finish before shutting down. Note that when acknowledgement batching is used, the container will also wait for ContainerOptions.getAcknowledgementShutdownTimeout().

Specified by:

getListenerShutdownTimeout in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the timeout.

getAcknowledgementShutdownTimeout

public Duration getAcknowledgementShutdownTimeout()

Description copied from interface: ContainerOptions

Return the maximum amount of time that the container should wait for batched acknowledgements to finish before shutting down. This timeout starts counting after listener processing is finished, including due to ContainerOptions.getListenerShutdownTimeout().

Specified by:

getAcknowledgementShutdownTimeout in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the timeout.

getBackPressureMode

public BackPressureMode getBackPressureMode()

Description copied from interface: ContainerOptions

Return the BackPressureMode for this container.

Specified by:

getBackPressureMode in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the backpressure mode.

getListenerMode

public ListenerMode getListenerMode()

Description copied from interface: ContainerOptions

Return the ListenerMode mode for this container.

Specified by:

getListenerMode in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the listener mode.

getMessageConverter

public MessagingMessageConverter<?> getMessageConverter()

Description copied from interface: ContainerOptions

Return the MessagingMessageConverter for this container.

Specified by:

getMessageConverter in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the message converter.

getAcknowledgementInterval

@Nullable
public Duration getAcknowledgementInterval()

Description copied from interface: ContainerOptions

Return the maximum interval between acknowledgements for batch acknowledgements.

Specified by:

getAcknowledgementInterval in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the interval.

getAcknowledgementThreshold

@Nullable
public Integer getAcknowledgementThreshold()

Description copied from interface: ContainerOptions

Return the threshold for triggering a batch acknowledgement.

Specified by:

getAcknowledgementThreshold in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the threshold.

getAcknowledgementMode

public AcknowledgementMode getAcknowledgementMode()

Description copied from interface: ContainerOptions

Return the AcknowledgementMode for this container.

Specified by:

getAcknowledgementMode in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the acknowledgement mode.

getAcknowledgementOrdering

@Nullable
public AcknowledgementOrdering getAcknowledgementOrdering()

Description copied from interface: ContainerOptions

Return the AcknowledgementOrdering for this container.

Specified by:

getAcknowledgementOrdering in interface ContainerOptions<O extends ContainerOptions<O,B>,B extends ContainerOptionsBuilder<B,O>>

Returns:

the acknowledgement ordering.