From 80fd0fda7df165e58c9d30f203b5bf3223d8cf44 Mon Sep 17 00:00:00 2001
From: Gary Russell <grussell@pivotal.io>
Date: Fri, 30 Mar 2018 16:41:10 -0400
Subject: [PATCH] GH-734: Option to suppress declaring Collections

Fixes https://github.com/spring-projects/spring-amqp/issues/734

Add `declareCollections` flag to admin (default false).

(cherry picked from commit 5423233)
---
 .../amqp/rabbit/core/RabbitAdmin.java         | 20 +++++++++++++--
 .../amqp/rabbit/core/RabbitAdminTests.java    | 25 +++++++++++++++++++
 src/reference/asciidoc/amqp.adoc              |  2 ++
 3 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitAdmin.java b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitAdmin.java
index eff27afc..727118a2 100644
--- a/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitAdmin.java
+++ b/spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitAdmin.java
@@ -19,6 +19,7 @@ package org.springframework.amqp.rabbit.core;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
@@ -109,6 +110,8 @@ public class RabbitAdmin implements AmqpAdmin, ApplicationContextAware, Applicat
 
 	private ApplicationEventPublisher applicationEventPublisher;
 
+	private boolean declareCollections = true;
+
 	private volatile DeclarationExceptionEvent lastDeclarationExceptionEvent;
 
 	/**
@@ -154,6 +157,17 @@ public class RabbitAdmin implements AmqpAdmin, ApplicationContextAware, Applicat
 		this.ignoreDeclarationExceptions = ignoreDeclarationExceptions;
 	}
 
+	/**
+	 * Set to false to disable declaring collections of {@link Declarable}.
+	 * Since the admin has to iterate over all Collection beans, this may
+	 * cause undesirable side-effects in some cases. Default true.
+	 * @param declareCollections set to false to prevent declarations of collections.
+	 * @since 1.7.7
+	 */
+	public void setDeclareCollections(boolean declareCollections) {
+		this.declareCollections = declareCollections;
+	}
+
 	/**
 	 * @return the last {@link DeclarationExceptionEvent} that was detected in this admin.
 	 *
@@ -416,6 +430,7 @@ public class RabbitAdmin implements AmqpAdmin, ApplicationContextAware, Applicat
 	 * Declares all the exchanges, queues and bindings in the enclosing application context, if any. It should be safe
 	 * (but unnecessary) to call this method more than once.
 	 */
+	@Override
 	public void initialize() {
 
 		if (this.applicationContext == null) {
@@ -432,8 +447,9 @@ public class RabbitAdmin implements AmqpAdmin, ApplicationContextAware, Applicat
 				this.applicationContext.getBeansOfType(Binding.class).values());
 
 		@SuppressWarnings("rawtypes")
-		Collection<Collection> collections = this.applicationContext.getBeansOfType(Collection.class, false, false)
-				.values();
+		Collection<Collection> collections = this.declareCollections
+			? this.applicationContext.getBeansOfType(Collection.class, false, false).values()
+			: Collections.emptyList();
 		for (Collection<?> collection : collections) {
 			if (collection.size() > 0 && collection.iterator().next() instanceof Declarable) {
 				for (Object declarable : collection) {
diff --git a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitAdminTests.java b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitAdminTests.java
index fae1ab85..0e125aa2 100644
--- a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitAdminTests.java
+++ b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitAdminTests.java
@@ -264,6 +264,19 @@ public class RabbitAdminTests {
 		ctx.close();
 	}
 
+	@Test
+	public void testMultiEntitiesSuppressed() {
+		ConfigurableApplicationContext ctx = new AnnotationConfigApplicationContext(Config1.class);
+		RabbitAdmin admin = ctx.getBean(RabbitAdmin.class);
+		assertNotNull(admin.getQueueProperties("q1"));
+		assertNull(admin.getQueueProperties("q2"));
+		assertNull(admin.getQueueProperties("q3"));
+		assertNull(admin.getQueueProperties("q4"));
+		admin.deleteQueue("q1");
+		admin.deleteExchange("e1");
+		ctx.close();
+	}
+
 	@Test
 	public void testAvoidHangAMQP_508() {
 		CachingConnectionFactory cf = new CachingConnectionFactory("localhost");
@@ -417,6 +430,18 @@ public class RabbitAdminTests {
 
 	}
 
+	@Configuration
+	public static class Config1 extends Config {
+
+		@Override
+		public RabbitAdmin admin(ConnectionFactory cf) {
+			RabbitAdmin admin = super.admin(cf);
+			admin.setDeclareCollections(false);
+			return admin;
+		}
+
+	}
+
 	private static final class EventPublisher implements ApplicationEventPublisher {
 
 		private final List<DeclarationExceptionEvent> events;
diff --git a/src/reference/asciidoc/amqp.adoc b/src/reference/asciidoc/amqp.adoc
index a8ec5c15..1a3feea0 100644
--- a/src/reference/asciidoc/amqp.adoc
+++ b/src/reference/asciidoc/amqp.adoc
@@ -3719,6 +3719,8 @@ public static class Config {
 }
 -----
 
+IMPORTANT: This feature can cause undesirable side effects in some cases, because the admin has to iterate over all `Collection<?>` beans.
+Starting with _versions 1.7.7, 2.0.4_, this feature can be disabled by setting the admin property `declareCollections` to `false`.
 
 [[conditional-declaration]]
 ===== Conditional Declaration