Class RabbitTemplateConfigurer

java.lang.Object

org.springframework.boot.rabbitmq.autoconfigure.RabbitTemplateConfigurer

public class RabbitTemplateConfigurer
extends Object

Configure RabbitTemplate with sensible defaults tuned using configuration properties.

Can be injected into application code and used to define a custom RabbitTemplate whose configuration is based upon that produced by auto-configuration.

Since:

4.2.0

Author:

Stephane Nicoll, Yanming Zhou

Constructor Summary

Constructors

Constructor	Description
RabbitTemplateConfigurer(RabbitProperties rabbitProperties)	Creates a new configurer that will use the given rabbitProperties.

Method Summary

Modifier and Type	Method	Description
void	configure(RabbitTemplate template, ConnectionFactory connectionFactory)	Configure the specified RabbitTemplate.
protected RetryTemplate	createRetryTemplate(RabbitProperties.Retry properties)
protected final RabbitProperties	getRabbitProperties()
void	setMessageConverter(@Nullable MessageConverter messageConverter)	Set the MessageConverter to use or null if the out-of-the-box converter should be used.
void	setObservationConvention(@Nullable RabbitTemplateObservationConvention observationConvention)	Sets the observation convention to use.
void	setRetrySettingsCustomizers(@Nullable List<RabbitTemplateRetrySettingsCustomizer> retrySettingsCustomizers)	Set the RabbitTemplateRetrySettingsCustomizer instances to use.

Methods inherited from class Object

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

Constructor Details

RabbitTemplateConfigurer

public RabbitTemplateConfigurer(RabbitProperties rabbitProperties)

Creates a new configurer that will use the given rabbitProperties.

Parameters:

rabbitProperties - properties to use

Method Details

setMessageConverter

public void setMessageConverter(@Nullable MessageConverter messageConverter)

Set the MessageConverter to use or null if the out-of-the-box converter should be used.

Parameters:

messageConverter - the MessageConverter

setRetrySettingsCustomizers

public void setRetrySettingsCustomizers(@Nullable List<RabbitTemplateRetrySettingsCustomizer> retrySettingsCustomizers)

Set the RabbitTemplateRetrySettingsCustomizer instances to use.

Parameters:

retrySettingsCustomizers - the retry settings customizers

setObservationConvention

public void setObservationConvention(@Nullable RabbitTemplateObservationConvention observationConvention)

Sets the observation convention to use.

Parameters:

observationConvention - the observation convention to use

getRabbitProperties

protected final RabbitProperties getRabbitProperties()

configure

public void configure(RabbitTemplate template,
 ConnectionFactory connectionFactory)

Configure the specified RabbitTemplate. The template can be further tuned and default settings can be overridden.

Parameters:

template - the RabbitTemplate instance to configure

connectionFactory - the ConnectionFactory to use

createRetryTemplate

protected RetryTemplate createRetryTemplate(RabbitProperties.Retry properties)