Package io.awspring.cloud.sqs.listener.acknowledgement

Class AbstractOrderingAcknowledgementProcessor<T>

java.lang.Object

io.awspring.cloud.sqs.listener.acknowledgement.AbstractOrderingAcknowledgementProcessor<T>

All Implemented Interfaces:

AcknowledgementCallback<T>, AcknowledgementProcessor<T>, ExecutingAcknowledgementProcessor<T>, ConfigurableContainerComponent, IdentifiableContainerComponent, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

BatchingAcknowledgementProcessor, ImmediateAcknowledgementProcessor

public abstract class AbstractOrderingAcknowledgementProcessor<T>
extends Object
implements ExecutingAcknowledgementProcessor<T>, AcknowledgementCallback<T>

Base implementation for a AcknowledgementProcessor with SmartLifecycle capabilities. Also provides acknowledgement ordering capabilities for AcknowledgementOrdering.ORDERED.

Since:

3.0

Author:

Tomaz Fernandes

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractOrderingAcknowledgementProcessor()

Method Summary

Modifier and Type	Method	Description
void	configure(ContainerOptions<?,?> containerOptions)	Configure the component with the provided ContainerOptions instance
protected void	doConfigure(ContainerOptions<?,?> containerOptions)
protected abstract CompletableFuture<Void>	doOnAcknowledge(Collection<Message<T>> messages)
protected abstract CompletableFuture<Void>	doOnAcknowledge(Message<T> message)
protected void	doStart()
protected void	doStop()
AcknowledgementCallback<T>	getAcknowledgementCallback()	Retrieve an acknowledgement callback that can be used to offer messages to be acknowledged by this processor.
String	getId()	Get the component id.
protected Function<Message<T>,String>	getMessageGroupingFunction()
boolean	isRunning()
CompletableFuture<Void>	onAcknowledge(Collection<Message<T>> messages)	Triggers acknowledgement for the given messages.
CompletableFuture<Void>	onAcknowledge(Message<T> message)	Triggers acknowledgement for the given message.
protected CompletableFuture<Void>	sendToExecutor(Collection<Message<T>> messagesToAck)
void	setAcknowledgementExecutor(AcknowledgementExecutor<T> acknowledgementExecutor)
void	setAcknowledgementResultCallback(AsyncAcknowledgementResultCallback<T> acknowledgementResultCallback)
void	setId(String id)	Set the component id.
void	setMaxAcknowledgementsPerBatch(int maxAcknowledgementsPerBatch)
void	setMessageGroupingFunction(Function<Message<T>,String> messageGroupingFunction)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, isAutoStartup, stop

Constructor Details

AbstractOrderingAcknowledgementProcessor

public AbstractOrderingAcknowledgementProcessor()

Method Details

getAcknowledgementCallback

public AcknowledgementCallback<T> getAcknowledgementCallback()

Description copied from interface: AcknowledgementProcessor

Retrieve an acknowledgement callback that can be used to offer messages to be acknowledged by this processor.

Specified by:

getAcknowledgementCallback in interface AcknowledgementProcessor<T>

Returns:

the callback.

configure

public void configure(ContainerOptions<?,?> containerOptions)

Description copied from interface: ConfigurableContainerComponent

Configure the component with the provided ContainerOptions instance

Specified by:

configure in interface ConfigurableContainerComponent

doConfigure

protected void doConfigure(ContainerOptions<?,?> containerOptions)

setAcknowledgementExecutor

public void setAcknowledgementExecutor(AcknowledgementExecutor<T> acknowledgementExecutor)

Specified by:

setAcknowledgementExecutor in interface ExecutingAcknowledgementProcessor<T>

setAcknowledgementResultCallback

public void setAcknowledgementResultCallback(AsyncAcknowledgementResultCallback<T> acknowledgementResultCallback)

Specified by:

setAcknowledgementResultCallback in interface ExecutingAcknowledgementProcessor<T>

setMaxAcknowledgementsPerBatch

public void setMaxAcknowledgementsPerBatch(int maxAcknowledgementsPerBatch)

setMessageGroupingFunction

public void setMessageGroupingFunction(Function<Message<T>,String> messageGroupingFunction)

setId

public void setId(String id)

Description copied from interface: IdentifiableContainerComponent

Set the component id.

Specified by:

setId in interface IdentifiableContainerComponent

Parameters:

id - the id.

getId

public String getId()

Description copied from interface: IdentifiableContainerComponent

Get the component id.

Specified by:

getId in interface IdentifiableContainerComponent

Returns:

the id.

start

public void start()

Specified by:

start in interface Lifecycle

doStart

protected void doStart()

onAcknowledge

public CompletableFuture<Void> onAcknowledge(Message<T> message)

Description copied from interface: AcknowledgementCallback

Triggers acknowledgement for the given message.

Specified by:

onAcknowledge in interface AcknowledgementCallback<T>

Parameters:

message - the message.

Returns:

a completable future.

onAcknowledge

public CompletableFuture<Void> onAcknowledge(Collection<Message<T>> messages)

Description copied from interface: AcknowledgementCallback

Triggers acknowledgement for the given messages.

Specified by:

onAcknowledge in interface AcknowledgementCallback<T>

Parameters:

messages - the messages.

Returns:

a completable future.

stop

public void stop()

Specified by:

stop in interface Lifecycle

doStop

protected void doStop()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getMessageGroupingFunction

protected Function<Message<T>,String> getMessageGroupingFunction()

sendToExecutor

protected CompletableFuture<Void> sendToExecutor(Collection<Message<T>> messagesToAck)

doOnAcknowledge

protected abstract CompletableFuture<Void> doOnAcknowledge(Message<T> message)

doOnAcknowledge

protected abstract CompletableFuture<Void> doOnAcknowledge(Collection<Message<T>> messages)