Implement comprehensive JMS ConnectionFactory configuration for Service Bus

sdk/spring/CHANGELOG.md

@@ -10,6 +10,27 @@ This section includes changes in `spring-cloud-azure-autoconfigure` module.
 
 - Add ConnectionDetails for ServiceBus. [#44019](https://github.com/Azure/azure-sdk-for-java/pull/44019).
 
+#### Breaking Changes
+
+- Change sender's default JmsConnectionFactory from ServiceBusJmsConnectionFactory to CachingConnectionFactory. [#47923](https://github.com/Azure/azure-sdk-for-java/issues/47923)
+
+The ConnectionFactory type is determined by the following configuration properties:
+
+  | `spring.jms.servicebus.pool.enabled` | `spring.jms.cache.enabled` | Sender ConnectionFactory       | Receiver ConnectionFactory     |
+  |--------------------------------------|----------------------------|--------------------------------|--------------------------------|
+  | not set                              | not set                    | CachingConnectionFactory       | ServiceBusJmsConnectionFactory |
+  | not set                              | true                       | CachingConnectionFactory       | CachingConnectionFactory       |
+  | not set                              | false                      | ServiceBusJmsConnectionFactory | ServiceBusJmsConnectionFactory |
+  | true                                 | not set                    | JmsPoolConnectionFactory       | JmsPoolConnectionFactory       |
+  | true                                 | true                       | CachingConnectionFactory       | CachingConnectionFactory       |
+  | true                                 | false                      | JmsPoolConnectionFactory       | JmsPoolConnectionFactory       |
+  | false                                | not set                    | CachingConnectionFactory       | ServiceBusJmsConnectionFactory |
+  | false                                | true                       | CachingConnectionFactory       | CachingConnectionFactory       |
+  | false                                | false                      | ServiceBusJmsConnectionFactory | ServiceBusJmsConnectionFactory |
+
+  **Note:** `CachingConnectionFactory` and `JmsPoolConnectionFactory` will be used only when they exist in classpath.
+
+
 ### Spring Cloud Azure Docker Compose
 
 This section includes changes in `spring-cloud-azure-docker-compose` module.

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/jms/ServiceBusJmsConnectionFactoryConfiguration.java

@@ -14,10 +14,10 @@
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
-import org.springframework.boot.jms.autoconfigure.JmsPoolConnectionFactoryFactory;
-import org.springframework.boot.jms.autoconfigure.JmsProperties;
 import org.springframework.boot.context.properties.bind.BindResult;
 import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.boot.jms.autoconfigure.JmsPoolConnectionFactoryFactory;
+import org.springframework.boot.jms.autoconfigure.JmsProperties;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
@@ -37,6 +37,58 @@
  */
 @Import(ServiceBusJmsConnectionFactoryConfiguration.Registrar.class)
 class ServiceBusJmsConnectionFactoryConfiguration {
+    static final int NOT_CONFIGURED = 0;
+    static final int TRUE = 1;
+    static final int FALSE = 2;
+    static final int POOL = 0;
+    static final int CACHE = 1;
+    static final int SERVICE_BUS = 2;
+
+    /**
+     * Creates a ServiceBusJmsConnectionFactory using the provided properties and customizers.
+     * This is a shared helper method used by both sender and receiver configurations.
+     *
+     * @param properties the Azure Service Bus JMS properties
+     * @param customizers the list of customizers to apply
+     * @return a configured ServiceBusJmsConnectionFactory instance
+     */
+    static ServiceBusJmsConnectionFactory createServiceBusJmsConnectionFactory(
+        AzureServiceBusJmsProperties properties,
+        java.util.List<AzureServiceBusJmsConnectionFactoryCustomizer> customizers) {
+        return new ServiceBusJmsConnectionFactoryFactory(properties, customizers)
+            .createConnectionFactory(ServiceBusJmsConnectionFactory.class);
+    }
+
+    /**
+     * Registers the appropriate ConnectionFactory bean based on configuration properties.
+     * <p>
+     * The ConnectionFactory type is determined by the following table:
+     * <table border="1">
+     *   <tr>
+     *     <th>spring.jms.servicebus.pool.enabled</th>
+     *     <th>spring.jms.cache.enabled</th>
+     *     <th>Sender ConnectionFactory</th>
+     *   </tr>
+     *   <tr><td>not set</td><td>not set</td><td>CachingConnectionFactory</td></tr>
+     *   <tr><td>not set</td><td>true</td><td>CachingConnectionFactory</td></tr>
+     *   <tr><td>not set</td><td>false</td><td>ServiceBusJmsConnectionFactory</td></tr>
+     *   <tr><td>true</td><td>not set</td><td>JmsPoolConnectionFactory</td></tr>
+     *   <tr><td>true</td><td>true</td><td>CachingConnectionFactory</td></tr>
+     *   <tr><td>true</td><td>false</td><td>JmsPoolConnectionFactory</td></tr>
+     *   <tr><td>false</td><td>not set</td><td>CachingConnectionFactory</td></tr>
+     *   <tr><td>false</td><td>true</td><td>CachingConnectionFactory</td></tr>
+     *   <tr><td>false</td><td>false</td><td>ServiceBusJmsConnectionFactory</td></tr>
+     * </table>
+     * <p>
+     */
+    private static final int[][] DECISION_TABLE = {
+        // pool: not set
+        {CACHE, CACHE, SERVICE_BUS}, // cache: not set, true, false
+        // pool: true
+        {POOL, CACHE, POOL}, // cache: not set, true, false
+        // pool: false
+        {CACHE, CACHE, SERVICE_BUS} // cache: not set, true, false
+    };
 
     static class Registrar implements BeanFactoryAware, EnvironmentAware, ImportBeanDefinitionRegistrar {
 
@@ -61,17 +113,44 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
             BindResult<Boolean> poolEnabledResult = Binder.get(environment).bind("spring.jms.servicebus.pool.enabled", Boolean.class);
             BindResult<Boolean> cacheEnabledResult = Binder.get(environment).bind("spring.jms.cache.enabled", Boolean.class);
 
-            if (isPoolConnectionFactoryClassPresent() && poolEnabledResult.orElseGet(() -> false)) {
-                registerJmsPoolConnectionFactory(registry);
-                return;
+            switch (getFactoryType(poolEnabledResult, cacheEnabledResult, DECISION_TABLE)) {
+                case POOL:
+                    registerJmsPoolConnectionFactory(registry);
+                    break;
+                case CACHE:
+                    registerJmsCachingConnectionFactory(registry);
+                    break;
+                default:
+                    registerServiceBusJmsConnectionFactory(registry);
             }
+        }
 
-            if (isCacheConnectionFactoryClassPresent() && cacheEnabledResult.orElseGet(() -> false)) {
-                registerJmsCachingConnectionFactory(registry);
-                return;
+        static int getFactoryType(BindResult<Boolean> poolEnabledResult, BindResult<Boolean> cacheEnabledResult, int[][] decisionTable) {
+            int poolIndex = NOT_CONFIGURED;
+            if (poolEnabledResult.isBound()) {
+                poolIndex = poolEnabledResult.get() ? TRUE : FALSE;
+            }
+            int cacheIndex = NOT_CONFIGURED;
+            if (cacheEnabledResult.isBound()) {
+                cacheIndex = cacheEnabledResult.get() ? TRUE : FALSE;
+            }
+            int configuredFactoryType = decisionTable[poolIndex][cacheIndex];
+            switch (configuredFactoryType) {
+                case POOL:
+                    if (isPoolConnectionFactoryClassPresent()) {
+                        return POOL;
+                    } else {
+                        return SERVICE_BUS;
+                    }
+                case CACHE:
+                    if (isCacheConnectionFactoryClassPresent()) {
+                        return CACHE;
+                    } else {
+                        return SERVICE_BUS;
+                    }
+                default:
+                    return SERVICE_BUS;
             }
-
-            registerServiceBusJmsConnectionFactory(registry);
         }
 
         private static boolean isCacheConnectionFactoryClassPresent() {
@@ -117,9 +196,9 @@ private void registerJmsPoolConnectionFactory(BeanDefinitionRegistry registry) {
         private ServiceBusJmsConnectionFactory createServiceBusJmsConnectionFactory() {
             AzureServiceBusJmsProperties serviceBusJmsProperties = beanFactory.getBean(AzureServiceBusJmsProperties.class);
             ObjectProvider<AzureServiceBusJmsConnectionFactoryCustomizer> factoryCustomizers = beanFactory.getBeanProvider(AzureServiceBusJmsConnectionFactoryCustomizer.class);
-            return new ServiceBusJmsConnectionFactoryFactory(serviceBusJmsProperties,
-                factoryCustomizers.orderedStream().collect(Collectors.toList()))
-                .createConnectionFactory(ServiceBusJmsConnectionFactory.class);
+            return ServiceBusJmsConnectionFactoryConfiguration.createServiceBusJmsConnectionFactory(
+                serviceBusJmsProperties,
+                factoryCustomizers.orderedStream().collect(Collectors.toList()));
         }
     }
 }