Switch JMS pooling to pooled-jms

This commit removes support for `activemq-pool` in benefit of
`pooled-jms`. While the former is not JMS 2 compliant, the latter is and
is independent of the ActiveMQ codebase (so potentially reusable in
custom code).

Closes gh-13927

Author: snicoll

Diff for: spring-boot-project/spring-boot-autoconfigure/pom.xml

@@ -183,17 +183,6 @@
 				</exclusion>
 			</exclusions>
 		</dependency>
-		<dependency>
-			<groupId>org.apache.activemq</groupId>
-			<artifactId>activemq-pool</artifactId>
-			<optional>true</optional>
-			<exclusions>
-				<exclusion>
-					<artifactId>geronimo-jms_1.1_spec</artifactId>
-					<groupId>org.apache.geronimo.specs</groupId>
-				</exclusion>
-			</exclusions>
-		</dependency>
 		<dependency>
 			<groupId>org.apache.activemq</groupId>
 			<artifactId>artemis-jms-client</artifactId>
@@ -346,6 +335,17 @@
 			<artifactId>jboss-transaction-spi</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.messaginghub</groupId>
+			<artifactId>pooled-jms</artifactId>
+			<optional>true</optional>
+			<exclusions>
+				<exclusion>
+					<groupId>org.apache.geronimo.specs</groupId>
+					<artifactId>geronimo-jms_2.0_spec</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
 		<dependency>
 			<groupId>org.mongodb</groupId>
 			<artifactId>mongodb-driver-async</artifactId>

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/PooledConnectionFactoryFactory.java renamed to spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsPoolConnectionFactoryFactory.java

@@ -14,36 +14,37 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.jms.activemq;
+package org.springframework.boot.autoconfigure.jms;
 
 import javax.jms.ConnectionFactory;
 
-import org.apache.activemq.jms.pool.PooledConnectionFactory;
+import org.messaginghub.pooled.jms.JmsPoolConnectionFactory;
 
 /**
- * Factory to create a {@link PooledConnectionFactory} from properties defined in
- * {@link PooledConnectionFactoryProperties}.
+ * Factory to create a {@link JmsPoolConnectionFactory} from properties defined in
+ * {@link JmsPoolConnectionFactoryProperties}.
  *
  * @author Stephane Nicoll
  * @since 2.1.0
  */
-public class PooledConnectionFactoryFactory {
+public class JmsPoolConnectionFactoryFactory {
 
-	private final PooledConnectionFactoryProperties properties;
+	private final JmsPoolConnectionFactoryProperties properties;
 
-	public PooledConnectionFactoryFactory(PooledConnectionFactoryProperties properties) {
+	public JmsPoolConnectionFactoryFactory(
+			JmsPoolConnectionFactoryProperties properties) {
 		this.properties = properties;
 	}
 
 	/**
-	 * Create a {@link PooledConnectionFactory} based on the specified
+	 * Create a {@link JmsPoolConnectionFactory} based on the specified
 	 * {@link ConnectionFactory}.
 	 * @param connectionFactory the connection factory to wrap
 	 * @return a pooled connection factory
 	 */
-	public PooledConnectionFactory createPooledConnectionFactory(
+	public JmsPoolConnectionFactory createPooledConnectionFactory(
 			ConnectionFactory connectionFactory) {
-		PooledConnectionFactory pooledConnectionFactory = new PooledConnectionFactory();
+		JmsPoolConnectionFactory pooledConnectionFactory = new JmsPoolConnectionFactory();
 		pooledConnectionFactory.setConnectionFactory(connectionFactory);
 
 		pooledConnectionFactory
@@ -53,14 +54,14 @@ public PooledConnectionFactory createPooledConnectionFactory(
 					this.properties.getBlockIfFullTimeout().toMillis());
 		}
 		if (this.properties.getIdleTimeout() != null) {
-			pooledConnectionFactory
-					.setIdleTimeout((int) this.properties.getIdleTimeout().toMillis());
+			pooledConnectionFactory.setConnectionIdleTimeout(
+					(int) this.properties.getIdleTimeout().toMillis());
 		}
 		pooledConnectionFactory.setMaxConnections(this.properties.getMaxConnections());
-		pooledConnectionFactory.setMaximumActiveSessionPerConnection(
-				this.properties.getMaximumActiveSessionPerConnection());
+		pooledConnectionFactory.setMaxSessionsPerConnection(
+				this.properties.getMaxSessionsPerConnection());
 		if (this.properties.getTimeBetweenExpirationCheck() != null) {
-			pooledConnectionFactory.setTimeBetweenExpirationCheckMillis(
+			pooledConnectionFactory.setConnectionCheckInterval(
 					this.properties.getTimeBetweenExpirationCheck().toMillis());
 		}
 		pooledConnectionFactory

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/PooledConnectionFactoryProperties.java renamed to spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsPoolConnectionFactoryProperties.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.jms.activemq;
+package org.springframework.boot.autoconfigure.jms;
 
 import java.time.Duration;
 
@@ -24,10 +24,10 @@
  * @author Stephane Nicoll
  * @since 2.1.0
  */
-public class PooledConnectionFactoryProperties {
+public class JmsPoolConnectionFactoryProperties {
 
 	/**
-	 * Whether a PooledConnectionFactory should be created, instead of a regular
+	 * Whether a JmsPoolConnectionFactory should be created, instead of a regular
 	 * ConnectionFactory.
 	 */
 	private boolean enabled;
@@ -54,9 +54,9 @@ public class PooledConnectionFactoryProperties {
 	private int maxConnections = 1;
 
 	/**
-	 * Maximum number of active sessions per connection.
+	 * Maximum number of pooled sessions per connection in the pool.
 	 */
-	private int maximumActiveSessionPerConnection = 500;
+	private int maxSessionsPerConnection = 500;
 
 	/**
 	 * Time to sleep between runs of the idle connection eviction thread. When negative,
@@ -110,13 +110,23 @@ public void setMaxConnections(int maxConnections) {
 		this.maxConnections = maxConnections;
 	}
 
+	@Deprecated
 	public int getMaximumActiveSessionPerConnection() {
-		return this.maximumActiveSessionPerConnection;
+		return getMaxSessionsPerConnection();
 	}
 
+	@Deprecated
 	public void setMaximumActiveSessionPerConnection(
 			int maximumActiveSessionPerConnection) {
-		this.maximumActiveSessionPerConnection = maximumActiveSessionPerConnection;
+		setMaxSessionsPerConnection(maximumActiveSessionPerConnection);
+	}
+
+	public int getMaxSessionsPerConnection() {
+		return this.maxSessionsPerConnection;
+	}
+
+	public void setMaxSessionsPerConnection(int maxSessionsPerConnection) {
+		this.maxSessionsPerConnection = maxSessionsPerConnection;
 	}
 
 	public Duration getTimeBetweenExpirationCheck() {

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQConnectionFactoryConfiguration.java

@@ -21,13 +21,14 @@
 import javax.jms.ConnectionFactory;
 
 import org.apache.activemq.ActiveMQConnectionFactory;
-import org.apache.activemq.jms.pool.PooledConnectionFactory;
 import org.apache.commons.pool2.PooledObject;
+import org.messaginghub.pooled.jms.JmsPoolConnectionFactory;
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.jms.JmsPoolConnectionFactoryFactory;
 import org.springframework.boot.autoconfigure.jms.JmsProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -94,20 +95,19 @@ private ActiveMQConnectionFactory createConnectionFactory() {
 	}
 
 	@Configuration
-	@ConditionalOnClass({ PooledConnectionFactory.class, PooledObject.class })
+	@ConditionalOnClass({ JmsPoolConnectionFactory.class, PooledObject.class })
 	static class PooledConnectionFactoryConfiguration {
 
 		@Bean(destroyMethod = "stop")
 		@ConditionalOnProperty(prefix = "spring.activemq.pool", name = "enabled", havingValue = "true", matchIfMissing = false)
-		public PooledConnectionFactory pooledJmsConnectionFactory(
+		public JmsPoolConnectionFactory pooledJmsConnectionFactory(
 				ActiveMQProperties properties,
 				ObjectProvider<List<ActiveMQConnectionFactoryCustomizer>> factoryCustomizers) {
 			ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactoryFactory(
 					properties, factoryCustomizers.getIfAvailable())
 							.createConnectionFactory(ActiveMQConnectionFactory.class);
-			return new PooledConnectionFactoryFactory(properties.getPool())
+			return new JmsPoolConnectionFactoryFactory(properties.getPool())
 					.createPooledConnectionFactory(connectionFactory);
-
 		}
 
 	}

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java

@@ -20,6 +20,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.springframework.boot.autoconfigure.jms.JmsPoolConnectionFactoryProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
@@ -72,7 +73,7 @@ public class ActiveMQProperties {
 	private Duration sendTimeout = Duration.ofMillis(0);
 
 	@NestedConfigurationProperty
-	private final PooledConnectionFactoryProperties pool = new PooledConnectionFactoryProperties();
+	private final JmsPoolConnectionFactoryProperties pool = new JmsPoolConnectionFactoryProperties();
 
 	private final Packages packages = new Packages();
 
@@ -132,7 +133,7 @@ public void setSendTimeout(Duration sendTimeout) {
 		this.sendTimeout = sendTimeout;
 	}
 
-	public PooledConnectionFactoryProperties getPool() {
+	public JmsPoolConnectionFactoryProperties getPool() {
 		return this.pool;
 	}
 

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisConnectionFactoryConfiguration.java

@@ -19,15 +19,15 @@
 import javax.jms.ConnectionFactory;
 
 import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory;
-import org.apache.activemq.jms.pool.PooledConnectionFactory;
 import org.apache.commons.pool2.PooledObject;
+import org.messaginghub.pooled.jms.JmsPoolConnectionFactory;
 
 import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.jms.JmsPoolConnectionFactoryFactory;
 import org.springframework.boot.autoconfigure.jms.JmsProperties;
-import org.springframework.boot.autoconfigure.jms.activemq.PooledConnectionFactoryFactory;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jms.connection.CachingConnectionFactory;
@@ -87,17 +87,17 @@ private ActiveMQConnectionFactory createConnectionFactory() {
 	}
 
 	@Configuration
-	@ConditionalOnClass({ PooledConnectionFactory.class, PooledObject.class })
+	@ConditionalOnClass({ JmsPoolConnectionFactory.class, PooledObject.class })
 	static class PooledConnectionFactoryConfiguration {
 
 		@Bean(destroyMethod = "stop")
 		@ConditionalOnProperty(prefix = "spring.artemis.pool", name = "enabled", havingValue = "true", matchIfMissing = false)
-		public PooledConnectionFactory pooledJmsConnectionFactory(
+		public JmsPoolConnectionFactory pooledJmsConnectionFactory(
 				ListableBeanFactory beanFactory, ArtemisProperties properties) {
 			ActiveMQConnectionFactory connectionFactory = new ArtemisConnectionFactoryFactory(
 					beanFactory, properties)
 							.createConnectionFactory(ActiveMQConnectionFactory.class);
-			return new PooledConnectionFactoryFactory(properties.getPool())
+			return new JmsPoolConnectionFactoryFactory(properties.getPool())
 					.createPooledConnectionFactory(connectionFactory);
 		}
 

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java

@@ -23,7 +23,7 @@
 
 import org.apache.activemq.artemis.core.remoting.impl.invm.TransportConstants;
 
-import org.springframework.boot.autoconfigure.jms.activemq.PooledConnectionFactoryProperties;
+import org.springframework.boot.autoconfigure.jms.JmsPoolConnectionFactoryProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
@@ -65,7 +65,7 @@ public class ArtemisProperties {
 	private final Embedded embedded = new Embedded();
 
 	@NestedConfigurationProperty
-	private final PooledConnectionFactoryProperties pool = new PooledConnectionFactoryProperties();
+	private final JmsPoolConnectionFactoryProperties pool = new JmsPoolConnectionFactoryProperties();
 
 	public ArtemisMode getMode() {
 		return this.mode;
@@ -111,7 +111,7 @@ public Embedded getEmbedded() {
 		return this.embedded;
 	}
 
-	public PooledConnectionFactoryProperties getPool() {
+	public JmsPoolConnectionFactoryProperties getPool() {
 		return this.pool;
 	}
 

Diff for: spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -49,6 +49,18 @@
       "description": "Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false).",
       "defaultValue": true
     },
+    {
+      "name": "spring.activemq.pool.maximum-active-session-per-connection",
+      "deprecation": {
+        "replacement": "spring.activemq.pool.max-sessions-per-connection"
+      }
+    },
+    {
+      "name": "spring.artemis.pool.maximum-active-session-per-connection",
+      "deprecation": {
+        "replacement": "spring.artemis.pool.max-sessions-per-connection"
+      }
+    },
     {
       "name": "spring.application.admin.enabled",
       "type": "java.lang.Boolean",

Diff for: spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jms/JmsAutoConfigurationTests.java

@@ -20,8 +20,8 @@
 import javax.jms.Session;
 
 import org.apache.activemq.ActiveMQConnectionFactory;
-import org.apache.activemq.jms.pool.PooledConnectionFactory;
 import org.junit.Test;
+import org.messaginghub.pooled.jms.JmsPoolConnectionFactory;
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.DirectFieldAccessor;
@@ -369,8 +369,8 @@ public void testActiveMQOverriddenPool() {
 				.withPropertyValues("spring.activemq.pool.enabled:true")
 				.run((context) -> {
 					JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
-					PooledConnectionFactory pool = context
-							.getBean(PooledConnectionFactory.class);
+					JmsPoolConnectionFactory pool = context
+							.getBean(JmsPoolConnectionFactory.class);
 					assertThat(jmsTemplate).isNotNull();
 					assertThat(pool).isNotNull();
 					assertThat(pool).isEqualTo(jmsTemplate.getConnectionFactory());
@@ -387,8 +387,8 @@ public void testActiveMQOverriddenPoolAndStandalone() {
 						"spring.activemq.inMemory:false")
 				.run((context) -> {
 					JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
-					PooledConnectionFactory pool = context
-							.getBean(PooledConnectionFactory.class);
+					JmsPoolConnectionFactory pool = context
+							.getBean(JmsPoolConnectionFactory.class);
 					assertThat(jmsTemplate).isNotNull();
 					assertThat(pool).isNotNull();
 					assertThat(pool).isEqualTo(jmsTemplate.getConnectionFactory());
@@ -405,8 +405,8 @@ public void testActiveMQOverriddenPoolAndRemoteServer() {
 						"spring.activemq.brokerUrl:tcp://remote-host:10000")
 				.run((context) -> {
 					JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
-					PooledConnectionFactory pool = context
-							.getBean(PooledConnectionFactory.class);
+					JmsPoolConnectionFactory pool = context
+							.getBean(JmsPoolConnectionFactory.class);
 					assertThat(jmsTemplate).isNotNull();
 					assertThat(pool).isNotNull();
 					assertThat(pool).isEqualTo(jmsTemplate.getConnectionFactory());