QPID-4238: escape tags for queue and virtualhost names with dots in them when accessing the XML configuration, works around CommonsConfiguration behaviour with element names containing dots

Applied patch from Jakub Scholz


git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1380037 13f79535-47bb-0310-9956-ffa450edef68

4 files changed, 53 insertions, 3 deletions

diff --git a/java/broker/src/main/java/org/apache/qpid/server/configuration/QueueConfiguration.java b/java/broker/src/main/java/org/apache/qpid/server/configuration/QueueConfiguration.java
index 8f03383777..cb7f8b2931 100644
--- a/java/broker/src/main/java/org/apache/qpid/server/configuration/QueueConfiguration.java
+++ b/java/broker/src/main/java/org/apache/qpid/server/configuration/QueueConfiguration.java
@@ -39,7 +39,7 @@ public class QueueConfiguration extends ConfigurationPlugin
         _name = name;
 
         CompositeConfiguration mungedConf = new CompositeConfiguration();
-        mungedConf.addConfiguration(_vHostConfig.getConfig().subset("queues.queue." + name));
+        mungedConf.addConfiguration(_vHostConfig.getConfig().subset("queues.queue." + escapeTagName(name)));
         mungedConf.addConfiguration(_vHostConfig.getConfig().subset("queues"));
 
         setConfiguration("virtualhosts.virtualhost.queues.queue", mungedConf);
diff --git a/java/broker/src/main/java/org/apache/qpid/server/configuration/ServerConfiguration.java b/java/broker/src/main/java/org/apache/qpid/server/configuration/ServerConfiguration.java
index 968f29a6e6..99625a22ad 100644
--- a/java/broker/src/main/java/org/apache/qpid/server/configuration/ServerConfiguration.java
+++ b/java/broker/src/main/java/org/apache/qpid/server/configuration/ServerConfiguration.java
@@ -349,7 +349,7 @@ public class ServerConfiguration extends ConfigurationPlugin
             String name = (String) hosts.get(j);
 
             // Add the virtual hosts to the server configuration
-            VirtualHostConfiguration virtualhost = new VirtualHostConfiguration(name, vhostConfiguration.subset("virtualhost." + name));
+            VirtualHostConfiguration virtualhost = new VirtualHostConfiguration(name, vhostConfiguration.subset("virtualhost." + escapeTagName(name)));
             _virtualHosts.put(virtualhost.getName(), virtualhost);
         }
     }
@@ -506,7 +506,7 @@ public class ServerConfiguration extends ConfigurationPlugin
             for (String hostName : _virtualHosts.keySet())
             {
                 VirtualHost vhost = vhostRegistry.getVirtualHost(hostName);
-                Configuration vhostConfig = newVhosts.subset("virtualhost." + hostName);
+                Configuration vhostConfig = newVhosts.subset("virtualhost." + escapeTagName(hostName));
                 vhost.getConfiguration().setConfiguration("virtualhosts.virtualhost", vhostConfig);
                 vhost.getSecurityManager().configureGlobalPlugins(this);
                 vhost.getSecurityManager().configureHostPlugins(vhost.getConfiguration());
diff --git a/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java b/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
index d08e3bc806..c7f600df8a 100644
--- a/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
+++ b/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
@@ -479,6 +479,11 @@ public abstract class ConfigurationPlugin
         return super.toString();
     }
 
+    public String escapeTagName(String name)
+    {
+        return name.replaceAll("\\.", "\\.\\.");
+    }
+
     protected void setConfig(Configuration config)
     {
         _config = config;
diff --git a/java/broker/src/test/java/org/apache/qpid/server/configuration/VirtualHostConfigurationTest.java b/java/broker/src/test/java/org/apache/qpid/server/configuration/VirtualHostConfigurationTest.java
index bd54c930dd..25e066de76 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/configuration/VirtualHostConfigurationTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/configuration/VirtualHostConfigurationTest.java
@@ -319,4 +319,49 @@ public class VirtualHostConfigurationTest extends InternalBrokerBaseCase
                      ce.getMessage());
          }
      }
+
+     /*
+      * Tests that the queues with dots in the names are fully supported. The XML configuration
+      * had problems with handling the tags containing dots due to the design of the Apache Commons
+      * Configuration library. The dots need to be escaped when accessing the XML configuration.
+      */
+     public void testDotsInQueueName() throws Exception
+     {
+         // Set up vhosts and queue
+         getConfigXml().addProperty("virtualhosts.virtualhost." + getName() + ".queues(-1).queue(-1).name", "dot.in.a.name");
+         // Add a single property which is inside the <dot.in.a.name> queue tag - the maximum delivery count
+         getConfigXml().addProperty("virtualhosts.virtualhost." + getName() + ".queues.queue.dot..in..a..name.maximumDeliveryCount", 5);
+
+         // Start the broker now.
+         super.createBroker();
+
+         // Get vhosts
+         VirtualHost test = ApplicationRegistry.getInstance().getVirtualHostRegistry().getVirtualHost(getName());
+
+         // Check, that the property stored within the <dot.in.a.name> tag has been properly loaded
+         assertEquals("queue with dots in its name has been properly loaded", 5, test.getConfiguration().getQueueConfiguration("dot.in.a.name").getMaxDeliveryCount());
+     }
+
+     /*
+      * Tests that the virtual hosts with dots in the names are fully supported. The XML
+      * configuration had problems with handling the tags containing dots due to the design
+      * of the Apache Commons Configuration library. The dots need to be escaped when
+      * accessing the XML configuration.
+      */
+     public void testDotsInVirtualHostName() throws Exception
+     {
+         // Set up vhosts
+         getConfigXml().addProperty("virtualhosts.virtualhost.name", "dot.in.a.name");
+         // Add a single property which is inside the <dot.in.a.name> virtual host tag - the message store
+         getConfigXml().addProperty("virtualhosts.virtualhost.dot..in..a..name.store.class", TestableMemoryMessageStore.class.getName());
+
+         // Start the broker now.
+         super.createBroker();
+
+         // Get vhosts
+         VirtualHost test = ApplicationRegistry.getInstance().getVirtualHostRegistry().getVirtualHost("dot.in.a.name");
+
+         // Check, that the property stored within the <dot.in.a.name> tag has been properly loaded
+         assertEquals("virtual host with dots in the name has been properly loaded", TestableMemoryMessageStore.class.getName(), test.getMessageStore().getClass().getName());
+     }
 }