From ffff7d7c12ca1eb12004f3b899f5c810e68999c8 Mon Sep 17 00:00:00 2001
From: Gary Russell <grussell@pivotal.io>
Date: Thu, 28 Sep 2017 12:11:23 -0400
Subject: [PATCH] AMQP-774: Add autoStartup to @RabbitListener

JIRA: https://jira.spring.io/browse/AMQP-774

Resolves https://github.com/spring-projects/spring-amqp/issues/669
---
 .../amqp/rabbit/annotation/RabbitListener.java  |  7 +++++++
 ...bbitListenerAnnotationBeanPostProcessor.java |  4 ++++
 .../AbstractRabbitListenerContainerFactory.java |  5 ++++-
 .../AbstractRabbitListenerEndpoint.java         | 17 +++++++++++++++++
 .../rabbit/listener/RabbitListenerEndpoint.java |  7 +++++++
 .../EnableRabbitIntegrationTests.java           |  8 +++++---
 src/reference/asciidoc/whats-new.adoc           |  2 ++
 7 files changed, 46 insertions(+), 4 deletions(-)

diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListener.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListener.java
index 2aef838e..8eda2048 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListener.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListener.java
@@ -233,4 +233,11 @@ public @interface RabbitListener {
 	 */
 	String concurrency() default "";
 
+	/**
+	 * Set to true or false, to override the default setting in the container factory.
+	 * @return true to auto start, false to not auto start.
+	 * @since 2.0
+	 */
+	String autoStartup() default "";
+
 }
diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListenerAnnotationBeanPostProcessor.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListenerAnnotationBeanPostProcessor.java
index 4f5b29ae..a196b2d3 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListenerAnnotationBeanPostProcessor.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitListenerAnnotationBeanPostProcessor.java
@@ -410,6 +410,10 @@ public class RabbitListenerAnnotationBeanPostProcessor
 				endpoint.setGroup((String) resolvedGroup);
 			}
 		}
+		String autoStartup = rabbitListener.autoStartup();
+		if (StringUtils.hasText(autoStartup)) {
+			endpoint.setAutoStartup(resolveExpressionAsBoolean(autoStartup));
+		}
 
 		endpoint.setExclusive(rabbitListener.exclusive());
 		String priority = resolve(rabbitListener.priority());
diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/AbstractRabbitListenerContainerFactory.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/AbstractRabbitListenerContainerFactory.java
index 360bf616..81f3d71f 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/AbstractRabbitListenerContainerFactory.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/AbstractRabbitListenerContainerFactory.java
@@ -340,7 +340,10 @@ public abstract class AbstractRabbitListenerContainerFactory<C extends AbstractM
 		if (this.applicationEventPublisher != null) {
 			instance.setApplicationEventPublisher(this.applicationEventPublisher);
 		}
-		if (this.autoStartup != null) {
+		if (endpoint.getAutoStartup() != null) {
+			instance.setAutoStartup(endpoint.getAutoStartup());
+		}
+		else if (this.autoStartup != null) {
 			instance.setAutoStartup(this.autoStartup);
 		}
 		if (this.phase != null) {
diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractRabbitListenerEndpoint.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractRabbitListenerEndpoint.java
index 73c8b94b..b88b574b 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractRabbitListenerEndpoint.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractRabbitListenerEndpoint.java
@@ -71,6 +71,8 @@ public abstract class AbstractRabbitListenerEndpoint implements RabbitListenerEn
 
 	private String group;
 
+	private Boolean autoStartup;
+
 	@Override
 	public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
 		this.beanFactory = beanFactory;
@@ -228,6 +230,21 @@ public abstract class AbstractRabbitListenerEndpoint implements RabbitListenerEn
 		this.group = group;
 	}
 
+
+	/**
+	 * Override the default autoStartup property.
+	 * @param autoStartup the autoStartup.
+	 * @since 2.0
+	 */
+	public void setAutoStartup(Boolean autoStartup) {
+		this.autoStartup = autoStartup;
+	}
+
+	@Override
+	public Boolean getAutoStartup() {
+		return this.autoStartup;
+	}
+
 	@Override
 	public void setupListenerContainer(MessageListenerContainer listenerContainer) {
 		AbstractMessageListenerContainer container = (AbstractMessageListenerContainer) listenerContainer;
diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/RabbitListenerEndpoint.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/RabbitListenerEndpoint.java
index ef60956a..a5b429af 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/RabbitListenerEndpoint.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/RabbitListenerEndpoint.java
@@ -48,6 +48,13 @@ public interface RabbitListenerEndpoint {
 	 */
 	String getConcurrency();
 
+	/**
+	 * Override of the default autoStartup property.
+	 * @return the autoStartup.
+	 * @since 2.0
+	 */
+	Boolean getAutoStartup();
+
 	/**
 	 * Setup the specified message listener container with the model
 	 * defined by this endpoint.
diff --git a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/annotation/EnableRabbitIntegrationTests.java b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/annotation/EnableRabbitIntegrationTests.java
index d91e7ffe..62bbd421 100644
--- a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/annotation/EnableRabbitIntegrationTests.java
+++ b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/annotation/EnableRabbitIntegrationTests.java
@@ -276,11 +276,13 @@ public class EnableRabbitIntegrationTests {
 
 	@Test
 	public void simpleDirectEndpoint() {
+		MessageListenerContainer container = this.registry.getListenerContainer("direct");
+		assertFalse(container.isRunning());
+		container.start();
 		String reply = (String) rabbitTemplate.convertSendAndReceive("test.simple.direct", "foo");
 		assertThat(reply, startsWith("FOOfoo"));
 		assertThat(reply, containsString("rabbitClientThread-")); // container runs on client thread
-		assertThat(TestUtils.getPropertyValue(this.registry.getListenerContainer("direct"), "consumersPerQueue"),
-				equalTo(2));
+		assertThat(TestUtils.getPropertyValue(container, "consumersPerQueue"), equalTo(2));
 	}
 
 	@Test
@@ -768,7 +770,7 @@ public class EnableRabbitIntegrationTests {
 			return foo.toUpperCase();
 		}
 
-		@RabbitListener(id = "direct", queues = "test.simple.direct",
+		@RabbitListener(id = "direct", queues = "test.simple.direct", autoStartup = "${no.property.here:false}",
 				containerFactory = "directListenerContainerFactory")
 		public String capitalizeDirect1(String foo) {
 			return foo.toUpperCase() + foo + Thread.currentThread().getName();
diff --git a/src/reference/asciidoc/whats-new.adoc b/src/reference/asciidoc/whats-new.adoc
index a615fea1..fbeb16f6 100644
--- a/src/reference/asciidoc/whats-new.adoc
+++ b/src/reference/asciidoc/whats-new.adoc
@@ -133,6 +133,8 @@ Also `@QueueBinding.exchange()` now supports custom exchange types and declares
 
 You can now set the `concurrency` of the listener container at the annotation level rather than having to configure a different container factory for different concurrency settings.
 
+You can now set the `autoStartup` property of the listener container at the annotation level, overriding the default setting in the container factory.
+
 See <<async-annotation-driven>> for more information.
 
 ===== Container Conditional Rollback