Package org.springframework.rabbit.stream.producer

Class RabbitStreamTemplate

java.lang.Object

org.springframework.rabbit.stream.producer.RabbitStreamTemplate

All Implemented Interfaces:

AutoCloseable, Aware, BeanNameAware, ApplicationContextAware, RabbitStreamOperations

public class RabbitStreamTemplate
extends Object
implements RabbitStreamOperations, ApplicationContextAware, BeanNameAware

Default implementation of RabbitStreamOperations.

Since:

2.4

Author:

Gary Russell, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
protected final LogAccessor	logger

Constructor Summary

Constructors

Constructor	Description
RabbitStreamTemplate(com.rabbitmq.stream.Environment environment, String streamName)	Construct an instance with the provided Environment.

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Boolean>	convertAndSend(Object message)	Convert to and send a Spring AMQP message.
CompletableFuture<Boolean>	convertAndSend(Object message, MessagePostProcessor mpp)	Convert to and send a Spring AMQP message.
com.rabbitmq.stream.MessageBuilder	messageBuilder()	Return the producer's MessageBuilder to create native stream messages.
MessageConverter	messageConverter()	Return the message converter.
CompletableFuture<Boolean>	send(com.rabbitmq.stream.Message message)	Send a native stream message.
CompletableFuture<Boolean>	send(Message message)	Send a Spring AMQP message.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanName(String name)
void	setMessageConverter(MessageConverter messageConverter)	Set a converter for convertAndSend(Object) operations.
void	setObservationEnabled(boolean observationEnabled)	Set to true to enable Micrometer observation.
void	setProducerCustomizer(ProducerCustomizer producerCustomizer)	Used to customize the ProducerBuilder before the Producer is built.
void	setStreamConverter(StreamMessageConverter streamConverter)	Set a converter to convert from Message to Message for send(Message) and convertAndSend(Object) methods.
void	setSuperStreamRouting(Function<com.rabbitmq.stream.Message,String> superStreamRouting)	Add a routing function, making the stream a super stream.
StreamMessageConverter	streamMessageConverter()	Return the stream message converter.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final LogAccessor logger

Constructor Details

RabbitStreamTemplate

public RabbitStreamTemplate(com.rabbitmq.stream.Environment environment,
 String streamName)

Construct an instance with the provided Environment.

Parameters:

environment - the environment.

streamName - the stream name.

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

setSuperStreamRouting

public void setSuperStreamRouting(Function<com.rabbitmq.stream.Message,String> superStreamRouting)

Add a routing function, making the stream a super stream.

Parameters:

superStreamRouting - the routing function.

Since:

3.0

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Set a converter for convertAndSend(Object) operations.

Parameters:

messageConverter - the converter.

setStreamConverter

public void setStreamConverter(StreamMessageConverter streamConverter)

Set a converter to convert from Message to Message for send(Message) and convertAndSend(Object) methods.

Parameters:

streamConverter - the converter.

setProducerCustomizer

public void setProducerCustomizer(ProducerCustomizer producerCustomizer)

Used to customize the ProducerBuilder before the Producer is built.

Parameters:

producerCustomizer - the customizer;

setObservationEnabled

public void setObservationEnabled(boolean observationEnabled)

Set to true to enable Micrometer observation.

Parameters:

observationEnabled - true to enable.

Since:

3.0.5

messageConverter

public MessageConverter messageConverter()

Description copied from interface: RabbitStreamOperations

Return the message converter.

Specified by:

messageConverter in interface RabbitStreamOperations

Returns:

the converter.

streamMessageConverter

public StreamMessageConverter streamMessageConverter()

Description copied from interface: RabbitStreamOperations

Return the stream message converter.

Specified by:

streamMessageConverter in interface RabbitStreamOperations

Returns:

the converter;

send

public CompletableFuture<Boolean> send(Message message)

Description copied from interface: RabbitStreamOperations

Send a Spring AMQP message.

Specified by:

send in interface RabbitStreamOperations

Parameters:

message - the message.

Returns:

a future to indicate success/failure.

convertAndSend

public CompletableFuture<Boolean> convertAndSend(Object message)

Description copied from interface: RabbitStreamOperations

Convert to and send a Spring AMQP message.

Specified by:

convertAndSend in interface RabbitStreamOperations

Parameters:

message - the payload.

Returns:

a future to indicate success/failure.

convertAndSend

public CompletableFuture<Boolean> convertAndSend(Object message,
 @Nullable
 MessagePostProcessor mpp)

Description copied from interface: RabbitStreamOperations

Convert to and send a Spring AMQP message. If a MessagePostProcessor is provided and returns null, the message is not sent and the future is completed with false.

Specified by:

convertAndSend in interface RabbitStreamOperations

Parameters:

message - the payload.

mpp - a message post processor.

Returns:

a future to indicate success/failure.

send

public CompletableFuture<Boolean> send(com.rabbitmq.stream.Message message)

Description copied from interface: RabbitStreamOperations

Send a native stream message.

Specified by:

send in interface RabbitStreamOperations

Parameters:

message - the message.

Returns:

a future to indicate success/failure.

See Also:

• RabbitStreamOperations.messageBuilder()

messageBuilder

public com.rabbitmq.stream.MessageBuilder messageBuilder()

Description copied from interface: RabbitStreamOperations

Return the producer's MessageBuilder to create native stream messages.

Specified by:

messageBuilder in interface RabbitStreamOperations

Returns:

the builder.

See Also:

• RabbitStreamOperations.send(com.rabbitmq.stream.Message)

close

public void close()

Close the underlying producer; a new producer will be created on the next operation that requires one.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RabbitStreamOperations