Move RabbitMQ Simple listener support to dedicated namespace

Move `spring.rabbitmq.listener.*` to `spring.rabbitmq.listener.simple.*`
in preparation for Spring AMQP 2.0 that supports different container
types.

Closes gh-9108
See gh-9055

Author: snicoll

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java

@@ -22,6 +22,7 @@
 import org.springframework.amqp.core.AcknowledgeMode;
 import org.springframework.amqp.rabbit.connection.CachingConnectionFactory.CacheMode;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
@@ -466,6 +467,111 @@ public void setSize(Integer size) {
 
 	public static class Listener {
 
+		@NestedConfigurationProperty
+		private final AmqpContainer simple = new AmqpContainer();
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.auto-startup")
+		@Deprecated
+		public boolean isAutoStartup() {
+			return getSimple().isAutoStartup();
+		}
+
+		@Deprecated
+		public void setAutoStartup(boolean autoStartup) {
+			getSimple().setAutoStartup(autoStartup);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.acknowledge-mode")
+		@Deprecated
+		public AcknowledgeMode getAcknowledgeMode() {
+			return getSimple().getAcknowledgeMode();
+		}
+
+		@Deprecated
+		public void setAcknowledgeMode(AcknowledgeMode acknowledgeMode) {
+			getSimple().setAcknowledgeMode(acknowledgeMode);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.concurrency")
+		@Deprecated
+		public Integer getConcurrency() {
+			return getSimple().getConcurrency();
+		}
+
+		@Deprecated
+		public void setConcurrency(Integer concurrency) {
+			getSimple().setConcurrency(concurrency);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.max-concurrency")
+		@Deprecated
+		public Integer getMaxConcurrency() {
+			return getSimple().getMaxConcurrency();
+		}
+
+		@Deprecated
+		public void setMaxConcurrency(Integer maxConcurrency) {
+			getSimple().setMaxConcurrency(maxConcurrency);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.prefetch")
+		@Deprecated
+		public Integer getPrefetch() {
+			return getSimple().getPrefetch();
+		}
+
+		@Deprecated
+		public void setPrefetch(Integer prefetch) {
+			getSimple().setPrefetch(prefetch);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.transaction-size")
+		@Deprecated
+		public Integer getTransactionSize() {
+			return getSimple().getTransactionSize();
+		}
+
+		@Deprecated
+		public void setTransactionSize(Integer transactionSize) {
+			getSimple().setTransactionSize(transactionSize);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.default-requeue-rejected")
+		@Deprecated
+		public Boolean getDefaultRequeueRejected() {
+			return getSimple().getDefaultRequeueRejected();
+		}
+
+		@Deprecated
+		public void setDefaultRequeueRejected(Boolean defaultRequeueRejected) {
+			getSimple().setDefaultRequeueRejected(defaultRequeueRejected);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.idle-event-interval")
+		@Deprecated
+		public Long getIdleEventInterval() {
+			return getSimple().getIdleEventInterval();
+		}
+
+		@Deprecated
+		public void setIdleEventInterval(Long idleEventInterval) {
+			getSimple().setIdleEventInterval(idleEventInterval);
+		}
+
+		@DeprecatedConfigurationProperty(replacement = "spring.rabbitmq.listener.simple.retry")
+		@Deprecated
+		public ListenerRetry getRetry() {
+			return getSimple().getRetry();
+		}
+
+		public AmqpContainer getSimple() {
+			return this.simple;
+		}
+
+	}
+
+	public static class AmqpContainer {
+
 		/**
 		 * Start the container automatically on startup.
 		 */

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/SimpleRabbitListenerContainerFactoryConfigurer.java

@@ -81,30 +81,31 @@ public void configure(SimpleRabbitListenerContainerFactory factory,
 		if (this.messageConverter != null) {
 			factory.setMessageConverter(this.messageConverter);
 		}
-		RabbitProperties.Listener listenerConfig = this.rabbitProperties.getListener();
-		factory.setAutoStartup(listenerConfig.isAutoStartup());
-		if (listenerConfig.getAcknowledgeMode() != null) {
-			factory.setAcknowledgeMode(listenerConfig.getAcknowledgeMode());
+		RabbitProperties.AmqpContainer config = this.rabbitProperties.getListener()
+				.getSimple();
+		factory.setAutoStartup(config.isAutoStartup());
+		if (config.getAcknowledgeMode() != null) {
+			factory.setAcknowledgeMode(config.getAcknowledgeMode());
 		}
-		if (listenerConfig.getConcurrency() != null) {
-			factory.setConcurrentConsumers(listenerConfig.getConcurrency());
+		if (config.getConcurrency() != null) {
+			factory.setConcurrentConsumers(config.getConcurrency());
 		}
-		if (listenerConfig.getMaxConcurrency() != null) {
-			factory.setMaxConcurrentConsumers(listenerConfig.getMaxConcurrency());
+		if (config.getMaxConcurrency() != null) {
+			factory.setMaxConcurrentConsumers(config.getMaxConcurrency());
 		}
-		if (listenerConfig.getPrefetch() != null) {
-			factory.setPrefetchCount(listenerConfig.getPrefetch());
+		if (config.getPrefetch() != null) {
+			factory.setPrefetchCount(config.getPrefetch());
 		}
-		if (listenerConfig.getTransactionSize() != null) {
-			factory.setTxSize(listenerConfig.getTransactionSize());
+		if (config.getTransactionSize() != null) {
+			factory.setTxSize(config.getTransactionSize());
 		}
-		if (listenerConfig.getDefaultRequeueRejected() != null) {
-			factory.setDefaultRequeueRejected(listenerConfig.getDefaultRequeueRejected());
+		if (config.getDefaultRequeueRejected() != null) {
+			factory.setDefaultRequeueRejected(config.getDefaultRequeueRejected());
 		}
-		if (listenerConfig.getIdleEventInterval() != null) {
-			factory.setIdleEventInterval(listenerConfig.getIdleEventInterval());
+		if (config.getIdleEventInterval() != null) {
+			factory.setIdleEventInterval(config.getIdleEventInterval());
 		}
-		ListenerRetry retryConfig = listenerConfig.getRetry();
+		ListenerRetry retryConfig = config.getRetry();
 		if (retryConfig.isEnabled()) {
 			RetryInterceptorBuilder<?> builder = (retryConfig.isStateless()
 					? RetryInterceptorBuilder.stateless()

spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -351,6 +351,72 @@
     "description": "Create an AmqpAdmin bean.",
     "defaultValue": true
   },
+  {
+    "name": "spring.rabbitmq.listener.retry.enabled",
+    "type": "java.lang.Boolean",
+    "description": "Whether or not publishing retries are enabled.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": false,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.enabled"
+    }
+  },
+  {
+    "name": "spring.rabbitmq.listener.retry.initial-interval",
+    "type": "java.lang.Long",
+    "description": "Interval between the first and second attempt to publish or deliver a message.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": 1000,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.initial-interval"
+    }
+  },
+  {
+    "name": "spring.rabbitmq.listener.retry.max-attempts",
+    "type": "java.lang.Integer",
+    "description": "Maximum number of attempts to publish or deliver a message.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": 3,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.max-attempts"
+    }
+  },
+  {
+    "name": "spring.rabbitmq.listener.retry.max-interval",
+    "type": "java.lang.Long",
+    "description": "Maximum interval between attempts.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": 10000,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.max-interval"
+    }
+  },
+  {
+    "name": "spring.rabbitmq.listener.retry.multiplier",
+    "type": "java.lang.Double",
+    "description": "A multiplier to apply to the previous retry interval.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": 1,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.multiplier"
+    }
+  },
+  {
+    "name": "spring.rabbitmq.listener.retry.stateless",
+    "type": "java.lang.Boolean",
+    "description": "Whether or not retries are stateless or stateful.",
+    "sourceType": "org.springframework.boot.autoconfigure.amqp.RabbitProperties$ListenerRetry",
+    "defaultValue": true,
+    "deprecated": true,
+    "deprecation": {
+      "replacement": "spring.rabbitmq.listener.simple.retry.stateless"
+    }
+  },
   {
     "name": "spring.session.hazelcast.flush-mode",
     "defaultValue": "on-save"

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java

@@ -293,9 +293,9 @@ public void testRabbitListenerContainerFactoryBackOff() {
 	}
 
 	@Test
-	public void testRabbitListenerContainerFactoryWithCustomSettings() {
-		load(new Class<?>[] { MessageConvertersConfiguration.class,
-				MessageRecoverersConfiguration.class },
+	@Deprecated
+	public void testSimpleRabbitListenerContainerFactoryWithCustomDeprecatedSettings() {
+		testSimpleRabbitListenerContainerFactoryWithCustomSettings(
 				"spring.rabbitmq.listener.retry.enabled:true",
 				"spring.rabbitmq.listener.retry.maxAttempts:4",
 				"spring.rabbitmq.listener.retry.initialInterval:2000",
@@ -309,10 +309,37 @@ public void testRabbitListenerContainerFactoryWithCustomSettings() {
 				"spring.rabbitmq.listener.defaultRequeueRejected:false",
 				"spring.rabbitmq.listener.idleEventInterval:5",
 				"spring.rabbitmq.listener.transactionSize:20");
+	}
+
+	@Test
+	public void testSimpleRabbitListenerContainerFactoryWithCustomSettings() {
+		testSimpleRabbitListenerContainerFactoryWithCustomSettings(
+				"spring.rabbitmq.listener.simple.retry.enabled:true",
+				"spring.rabbitmq.listener.simple.retry.maxAttempts:4",
+				"spring.rabbitmq.listener.simple.retry.initialInterval:2000",
+				"spring.rabbitmq.listener.simple.retry.multiplier:1.5",
+				"spring.rabbitmq.listener.simple.retry.maxInterval:5000",
+				"spring.rabbitmq.listener.simple.autoStartup:false",
+				"spring.rabbitmq.listener.simple.acknowledgeMode:manual",
+				"spring.rabbitmq.listener.simple.concurrency:5",
+				"spring.rabbitmq.listener.simple.maxConcurrency:10",
+				"spring.rabbitmq.listener.simple.prefetch:40",
+				"spring.rabbitmq.listener.simple.defaultRequeueRejected:false",
+				"spring.rabbitmq.listener.simple.idleEventInterval:5",
+				"spring.rabbitmq.listener.simple.transactionSize:20");
+	}
+
+	private void testSimpleRabbitListenerContainerFactoryWithCustomSettings(String... environment) {
+		load(new Class<?>[] { MessageConvertersConfiguration.class,
+						MessageRecoverersConfiguration.class }, environment);
 		SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory = this.context
 				.getBean("rabbitListenerContainerFactory",
 						SimpleRabbitListenerContainerFactory.class);
 		DirectFieldAccessor dfa = new DirectFieldAccessor(rabbitListenerContainerFactory);
+		checkCommonProps(dfa);
+	}
+
+	private void checkCommonProps(DirectFieldAccessor dfa) {
 		assertThat(dfa.getPropertyValue("autoStartup")).isEqualTo(Boolean.FALSE);
 		assertThat(dfa.getPropertyValue("acknowledgeMode"))
 				.isEqualTo(AcknowledgeMode.MANUAL);

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -936,20 +936,20 @@ content into your application; rather pick only the properties that you need.
 	spring.rabbitmq.connection-timeout= # Connection timeout, in milliseconds; zero for infinite.
 	spring.rabbitmq.dynamic=true # Create an AmqpAdmin bean.
 	spring.rabbitmq.host=localhost # RabbitMQ host.
-	spring.rabbitmq.listener.acknowledge-mode= # Acknowledge mode of container.
-	spring.rabbitmq.listener.auto-startup=true # Start the container automatically on startup.
-	spring.rabbitmq.listener.concurrency= # Minimum number of consumers.
-	spring.rabbitmq.listener.default-requeue-rejected= # Whether or not to requeue delivery failures; default `true`.
-	spring.rabbitmq.listener.idle-event-interval= # How often idle container events should be published in milliseconds.
-	spring.rabbitmq.listener.max-concurrency= # Maximum number of consumers.
-	spring.rabbitmq.listener.prefetch= # Number of messages to be handled in a single request. It should be greater than or equal to the transaction size (if used).
-	spring.rabbitmq.listener.retry.enabled=false # Whether or not publishing retries are enabled.
-	spring.rabbitmq.listener.retry.initial-interval=1000 # Interval between the first and second attempt to deliver a message.
-	spring.rabbitmq.listener.retry.max-attempts=3 # Maximum number of attempts to deliver a message.
-	spring.rabbitmq.listener.retry.max-interval=10000 # Maximum interval between attempts.
-	spring.rabbitmq.listener.retry.multiplier=1.0 # A multiplier to apply to the previous delivery retry interval.
-	spring.rabbitmq.listener.retry.stateless=true # Whether or not retry is stateless or stateful.
-	spring.rabbitmq.listener.transaction-size= # Number of messages to be processed in a transaction. For best results it should be less than or equal to the prefetch count.
+	spring.rabbitmq.listener.simple.acknowledge-mode= # Acknowledge mode of container.
+	spring.rabbitmq.listener.simple.auto-startup=true # Start the container automatically on startup.
+	spring.rabbitmq.listener.simple.concurrency= # Minimum number of consumers.
+	spring.rabbitmq.listener.simple.default-requeue-rejected= # Whether or not to requeue delivery failures; default `true`.
+	spring.rabbitmq.listener.simple.idle-event-interval= # How often idle container events should be published in milliseconds.
+	spring.rabbitmq.listener.simple.max-concurrency= # Maximum number of consumers.
+	spring.rabbitmq.listener.simple.prefetch= # Number of messages to be handled in a single request. It should be greater than or equal to the transaction size (if used).
+	spring.rabbitmq.listener.simple.retry.enabled=false # Whether or not publishing retries are enabled.
+	spring.rabbitmq.listener.simple.retry.initial-interval=1000 # Interval between the first and second attempt to deliver a message.
+	spring.rabbitmq.listener.simple.retry.max-attempts=3 # Maximum number of attempts to deliver a message.
+	spring.rabbitmq.listener.simple.retry.max-interval=10000 # Maximum interval between attempts.
+	spring.rabbitmq.listener.simple.retry.multiplier=1.0 # A multiplier to apply to the previous delivery retry interval.
+	spring.rabbitmq.listener.simple.retry.stateless=true # Whether or not retry is stateless or stateful.
+	spring.rabbitmq.listener.simple.transaction-size= # Number of messages to be processed in a transaction. For best results it should be less than or equal to the prefetch count.
 	spring.rabbitmq.password= # Login to authenticate against the broker.
 	spring.rabbitmq.port=5672 # RabbitMQ port.
 	spring.rabbitmq.publisher-confirms=false # Enable publisher confirms.