Package io.awspring.cloud.sqs.listener.sink

Class AbstractMessageProcessingPipelineSink<T>

java.lang.Object

io.awspring.cloud.sqs.listener.sink.AbstractMessageProcessingPipelineSink<T>

Type Parameters:

T - the Message payload type.

All Implemented Interfaces:

ConfigurableContainerComponent, ObservableComponent, MessageProcessingPipelineSink<T>, MessageSink<T>, TaskExecutorAware, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

BatchMessageSink, FanOutMessageSink, OrderedMessageSink

public abstract class AbstractMessageProcessingPipelineSink<T>
extends Object
implements MessageProcessingPipelineSink<T>, TaskExecutorAware, ObservableComponent

Base implementation for MessageProcessingPipelineSink containing SmartLifecycle features and useful execution methods that can be used by subclasses.

Since:

3.0

Author:

Tomaz Fernandes

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractMessageProcessingPipelineSink()

Method Summary

Modifier and Type	Method	Description
void	configure(ContainerOptions<?,?> containerOptions)	Configure the component with the provided ContainerOptions instance
protected abstract CompletableFuture<Void>	doEmit(Collection<Message<T>> messages, MessageProcessingContext<T> context)
CompletableFuture<Void>	emit(Collection<Message<T>> messages, MessageProcessingContext<T> context)	Emit the provided Message instances to the provided AsyncMessageListener.
protected CompletableFuture<Void>	execute(Collection<Message<T>> messages, MessageProcessingContext<T> context)	Send the provided Message instances to the TaskExecutor as a unit of work.
protected CompletableFuture<Void>	execute(Message<T> message, MessageProcessingContext<T> context)	Send the provided Message to the TaskExecutor as a unit of work.
boolean	isRunning()
protected Void	logError(Throwable t, Collection<Message<T>> msgs)
protected Void	logError(Throwable t, Message<T> msg)
void	setMessagePipeline(MessageProcessingPipeline<T> messageProcessingPipeline)	Set the MessageProcessingPipeline instance that this sink will emit Message instances to.
void	setObservationSpecifics(AbstractListenerObservation.Specifics<?> observationSpecifics)	Set the Observation-related instances that are specific to a messaging system.
void	setTaskExecutor(TaskExecutor taskExecutor)	Set the task executor.
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

AbstractMessageProcessingPipelineSink

public AbstractMessageProcessingPipelineSink()

Method Details

setMessagePipeline

public void setMessagePipeline(MessageProcessingPipeline<T> messageProcessingPipeline)

Description copied from interface: MessageProcessingPipelineSink

Set the MessageProcessingPipeline instance that this sink will emit Message instances to.

Specified by:

setMessagePipeline in interface MessageProcessingPipelineSink<T>

Parameters:

messageProcessingPipeline - the pipeline.

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

Description copied from interface: TaskExecutorAware

Set the task executor.

Specified by:

setTaskExecutor in interface TaskExecutorAware

Parameters:

taskExecutor - the task executor.

setObservationSpecifics

public void setObservationSpecifics(AbstractListenerObservation.Specifics<?> observationSpecifics)

Description copied from interface: ObservableComponent

Set the Observation-related instances that are specific to a messaging system.

Specified by:

setObservationSpecifics in interface ObservableComponent

Parameters:

observationSpecifics - the observation-related instances.

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

emit

public CompletableFuture<Void> emit(Collection<Message<T>> messages,
 MessageProcessingContext<T> context)

Description copied from interface: MessageSink

Emit the provided Message instances to the provided AsyncMessageListener.

Specified by:

emit in interface MessageSink<T>

Parameters:

messages - the messages to emit.

Returns:

a collection of CompletableFuture instances, each representing the completion signal of a single message processing.

doEmit

protected abstract CompletableFuture<Void> doEmit(Collection<Message<T>> messages,
 MessageProcessingContext<T> context)

execute

protected CompletableFuture<Void> execute(Message<T> message,
 MessageProcessingContext<T> context)

Send the provided Message to the TaskExecutor as a unit of work.

Parameters:

message - the message to be executed.

context - the processing context.

Returns:

the processing result.

execute

protected CompletableFuture<Void> execute(Collection<Message<T>> messages,
 MessageProcessingContext<T> context)

Send the provided Message instances to the TaskExecutor as a unit of work.

Parameters:

messages - the messages to be executed.

context - the processing context.

Returns:

the processing result.

logError

protected Void logError(Throwable t,
 Message<T> msg)

logError

protected Void logError(Throwable t,
 Collection<Message<T>> msgs)

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle