QPID-2581 : Update ConfigurationPlugin to correctly handle attributes in configuration.

Added work around for the fact that we use a Composite Configuration that turns an XML attribute key of '[@attribute]' in to '@attribute]'. Added test for to this conversion.

This makes the Plugin Configuration interface consistent so if we swap our configuration format. The key style of '[@attribute]' will work as expected.

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

2 files changed, 108 insertions, 2 deletions

diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
index dc0410dba6..bac6e5c4d7 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/ConfigurationPlugin.java
@@ -94,7 +94,7 @@ public abstract class ConfigurationPlugin
 
             //Trim any element properties
             elementNameIndex = element.indexOf("[");
-            if (elementNameIndex != -1)
+            if (elementNameIndex > 0)
             {
                 element = element.substring(0,elementNameIndex).trim();
             }
@@ -106,6 +106,18 @@ public abstract class ConfigurationPlugin
         //Remove the items we already expect in the configuration
         for (String tag : getElementsProcessed())
         {
+
+            // Work round the issue with Commons configuration.
+            // With an XMLConfiguration the key will be [@property]
+            // but with a CompositeConfiguration it will be @property].
+            // Hide this issue from our users so when/if we change the
+            // configuration they don't have to. 
+            int bracketIndex = tag.indexOf("[");
+            if (bracketIndex != -1)
+            {                
+                tag = tag.substring(bracketIndex + 1, tag.length());
+            }
+
             elements.remove(tag);
         }
 
@@ -116,7 +128,7 @@ public abstract class ConfigurationPlugin
                 _logger.info("Elements to lookup:" + path);
                 for (String tag : elements)
                 {
-                    _logger.info(tag);
+                    _logger.info("Tag:'"+tag+"'");
                 }
             }
         }
diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/configuration/plugins/ConfigurationPluginTest.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/configuration/plugins/ConfigurationPluginTest.java
new file mode 100644
index 0000000000..b9c8e39d1f
--- /dev/null
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/configuration/plugins/ConfigurationPluginTest.java
@@ -0,0 +1,94 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+package org.apache.qpid.server.configuration.plugins;
+
+import junit.framework.TestCase;
+import org.apache.commons.configuration.CompositeConfiguration;
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
+import org.apache.commons.configuration.XMLConfiguration;
+
+/**
+ * Test that verifies that given a configuration the
+ * Plugin manager
+ */
+public class ConfigurationPluginTest extends TestCase
+{
+
+    class ConfigPlugin extends ConfigurationPlugin
+    {
+        @Override
+        public String[] getElementsProcessed()
+        {
+                return new String[]{"[@property]", "name"};
+        }
+
+        public String getName()
+        {
+            return _configuration.getString("name");
+        }
+
+        public String getProperty()
+        {
+            return _configuration.getString("[@property]");
+        }
+
+
+    }
+
+    Configuration _configuration;
+
+    public void setUp()
+    {
+        XMLConfiguration xmlconfig = new XMLConfiguration();
+        xmlconfig.addProperty("base.element[@property]","property");
+        xmlconfig.addProperty("base.element.name","name");
+
+        //Use a composite configuration as this is what our broker code uses.
+        CompositeConfiguration composite  = new CompositeConfiguration();
+        composite.addConfiguration(xmlconfig);
+
+        _configuration = composite;
+    }
+
+
+    public void testValuesRetreived()
+    {
+       ConfigPlugin plugin = new ConfigPlugin();
+
+        try
+        {
+            plugin.setConfiguration("base.element", _configuration.subset("base.element"));
+        }
+        catch (ConfigurationException e)
+        {
+            e.printStackTrace();
+            fail(e.toString());
+        }
+
+        assertEquals("Name not correct","name",plugin.getName());
+        assertEquals("Property not correct","property",plugin.getProperty());
+    }
+
+
+
+
+}