Package org.springframework.rabbit.stream.listener

Class StreamListenerContainer

java.lang.Object

org.springframework.rabbit.stream.listener.StreamListenerContainer

All Implemented Interfaces:

MessageListenerContainer, Aware, BeanNameAware, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class StreamListenerContainer
extends Object
implements MessageListenerContainer, BeanNameAware

A listener container for RabbitMQ Streams.

Since:

2.4

Author:

Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
protected LogAccessor	logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
StreamListenerContainer(com.rabbitmq.stream.Environment environment)	Construct an instance using the provided environment.
StreamListenerContainer(com.rabbitmq.stream.Environment environment, com.rabbitmq.stream.Codec codec)	Construct an instance using the provided environment and codec.

Method Summary

Modifier and Type	Method	Description
String	getBeanName()	Return the bean name.
String	getListenerId()	The 'id' attribute of the listener.
Object	getMessageListener()	Get the message listener.
StreamMessageConverter	getStreamConverter()	Get a StreamMessageConverter used to convert a Message to a Message.
boolean	isAutoStartup()
boolean	isRunning()
void	setAdviceChain(Advice... advices)	Set an advice chain to apply to the listener.
void	setAutoStartup(boolean autoStart)	Set auto startup.
void	setBeanName(String beanName)
void	setConsumerCustomizer(ConsumerCustomizer consumerCustomizer)	Customize the consumer builder before it is built.
void	setListenerId(String listenerId)	Set the listener id.
void	setQueueNames(String... queueNames)	Set the queue names.
void	setStreamConverter(StreamMessageConverter messageConverter)	Set a StreamMessageConverter used to convert a Message to a Message.
void	setupMessageListener(MessageListener messageListener)	Setup the message listener to use.
void	start()
void	stop()
void	superStream(String streamName, String name)	Enable Single Active Consumer on a Super Stream, with one consumer.
void	superStream(String streamName, String name, int consumers)	Enable Single Active Consumer on a Super Stream with the provided number of consumers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.amqp.rabbit.listener.MessageListenerContainer

afterPropertiesSet, isConsumerBatchEnabled, lazyLoad

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, stop

Field Details

logger

protected LogAccessor logger

Constructor Details

StreamListenerContainer

public StreamListenerContainer(com.rabbitmq.stream.Environment environment)

Construct an instance using the provided environment.

Parameters:

environment - the environment.

StreamListenerContainer

public StreamListenerContainer(com.rabbitmq.stream.Environment environment,
 @Nullable
 com.rabbitmq.stream.Codec codec)

Construct an instance using the provided environment and codec.

Parameters:

environment - the environment.

codec - the codec used to create reply messages.

Method Details

setQueueNames

public void setQueueNames(String... queueNames)

Set the queue names. Mutually exclusive with superStream(String, String).

Specified by:

setQueueNames in interface MessageListenerContainer

Parameters:

queueNames - the queue names.

superStream

public void superStream(String streamName,
 String name)

Enable Single Active Consumer on a Super Stream, with one consumer. Mutually exclusive with setQueueNames(String...).

Parameters:

streamName - the stream.

name - the consumer name.

Since:

3.0

superStream

public void superStream(String streamName,
 String name,
 int consumers)

Enable Single Active Consumer on a Super Stream with the provided number of consumers. There must be at least that number of partitions in the Super Stream. Mutually exclusive with setQueueNames(String...).

Parameters:

streamName - the stream.

name - the consumer name.

consumers - the number of consumers.

Since:

3.0

getStreamConverter

public StreamMessageConverter getStreamConverter()

Get a StreamMessageConverter used to convert a Message to a Message.

Returns:

the converter.

setStreamConverter

public void setStreamConverter(StreamMessageConverter messageConverter)

Set a StreamMessageConverter used to convert a Message to a Message.

Parameters:

messageConverter - the converter.

setConsumerCustomizer

public void setConsumerCustomizer(ConsumerCustomizer consumerCustomizer)

Customize the consumer builder before it is built.

Parameters:

consumerCustomizer - the customizer.

getListenerId

@Nullable
public String getListenerId()

The 'id' attribute of the listener.

Returns:

the id (or the container bean name if no id set).

setListenerId

public void setListenerId(String listenerId)

Description copied from interface: MessageListenerContainer

Set the listener id.

Specified by:

setListenerId in interface MessageListenerContainer

Parameters:

listenerId - the id.

getBeanName

@Nullable
public String getBeanName()

Return the bean name.

Returns:

the bean name.

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface BeanNameAware

setAutoStartup

public void setAutoStartup(boolean autoStart)

Description copied from interface: MessageListenerContainer

Set auto startup.

Specified by:

setAutoStartup in interface MessageListenerContainer

Parameters:

autoStart - true to auto start.

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

setAdviceChain

public void setAdviceChain(Advice... advices)

Set an advice chain to apply to the listener.

Parameters:

advices - the advice chain.

Since:

2.4.5

getMessageListener

@Nullable
public Object getMessageListener()

Description copied from interface: MessageListenerContainer

Get the message listener.

Specified by:

getMessageListener in interface MessageListenerContainer

Returns:

The message listener object.

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

setupMessageListener

public void setupMessageListener(MessageListener messageListener)

Description copied from interface: MessageListenerContainer

Setup the message listener to use. Throws an IllegalArgumentException if that message listener type is not supported.

Specified by:

setupMessageListener in interface MessageListenerContainer

Parameters:

messageListener - the object to wrapped to the MessageListener.