QPID-5821: [Java Broker] Refactor MessageStore and DurableConfigurationStore interfaces to remove message store settings map.

VirtualHost model objects now have attributes.

Work done by Keith Wall <kwall@apache.org> and me.

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

10 files changed, 145 insertions, 61 deletions

diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/DefaultConnectionProviderFactory.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/DefaultConnectionProviderFactory.java
index d528ab9253..2d8eec2021 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/DefaultConnectionProviderFactory.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/DefaultConnectionProviderFactory.java
@@ -20,8 +20,7 @@
  */
 package org.apache.qpid.server.store.jdbc;
 
-import java.util.Map;
-
+import org.apache.qpid.server.model.ConfiguredObject;
 import org.apache.qpid.server.plugin.JDBCConnectionProviderFactory;
 import org.apache.qpid.server.plugin.PluggableService;
 
@@ -38,7 +37,7 @@ public class DefaultConnectionProviderFactory implements JDBCConnectionProviderF
     }
 
     @Override
-    public ConnectionProvider getConnectionProvider(String connectionUrl, Map<String, Object> settings)
+    public ConnectionProvider getConnectionProvider(ConfiguredObject<?> parent, String connectionUrl)
     {
         return new DefaultConnectionProvider(connectionUrl);
     }
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericAbstractJDBCMessageStore.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericAbstractJDBCMessageStore.java
index bd245fa4f4..ce612ec0b6 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericAbstractJDBCMessageStore.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericAbstractJDBCMessageStore.java
@@ -20,7 +20,6 @@ package org.apache.qpid.server.store.jdbc;
 
 
 import java.util.List;
-import java.util.Map;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.atomic.AtomicBoolean;
 
@@ -37,20 +36,20 @@ public abstract class GenericAbstractJDBCMessageStore extends org.apache.qpid.se
     private ConfiguredObject<?> _parent;
 
     @Override
-    public final void openMessageStore(ConfiguredObject<?> parent, Map<String, Object> storeSettings)
+    public final void openMessageStore(ConfiguredObject<?> parent)
     {
         if (_messageStoreOpen.compareAndSet(false, true))
         {
             _parent = parent;
 
-            doOpen(parent, storeSettings);
+            doOpen(parent);
 
             createOrOpenMessageStoreDatabase();
             setMaximumMessageId();
         }
     }
 
-    protected abstract void doOpen(final ConfiguredObject<?> parent, final Map<String, Object> storeSettings)
+    protected abstract void doOpen(final ConfiguredObject<?> parent)
             throws StoreException;
 
     @Override
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCConfigurationStore.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCConfigurationStore.java
index aa8c38cbb0..479ebd953b 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCConfigurationStore.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCConfigurationStore.java
@@ -24,7 +24,6 @@ import java.sql.Blob;
 import java.sql.Connection;
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.util.Map;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import org.apache.log4j.Logger;
@@ -43,9 +42,6 @@ public class GenericJDBCConfigurationStore extends AbstractJDBCConfigurationStor
 
     private static final Logger LOGGER = Logger.getLogger(GenericJDBCConfigurationStore.class);
 
-    public static final String CONNECTION_URL = "connectionUrl";
-    public static final String CONNECTION_POOL_TYPE = "connectionPoolType";
-
     private final AtomicBoolean _configurationStoreOpen = new AtomicBoolean();
     private final MessageStore _providedMessageStore = new ProvidedMessageStore();
 
@@ -60,14 +56,15 @@ public class GenericJDBCConfigurationStore extends AbstractJDBCConfigurationStor
     private ConfiguredObject<?> _parent;
 
     @Override
-    public void openConfigurationStore(ConfiguredObject<?> parent, Map<String, Object> storeSettings)
+    public void openConfigurationStore(ConfiguredObject<?> parent)
             throws StoreException
     {
         if (_configurationStoreOpen.compareAndSet(false,  true))
         {
             _parent = parent;
-            _connectionURL = String.valueOf(storeSettings.get(CONNECTION_URL));
-            Object poolAttribute = storeSettings.get(CONNECTION_POOL_TYPE);
+
+            JDBCSettings settings = (JDBCSettings)parent;
+            _connectionURL = settings.getConnectionUrl();
 
             JDBCDetails details = JDBCDetails.getDetailsForJdbcUrl(_connectionURL, parent.getContext());
 
@@ -82,7 +79,7 @@ public class GenericJDBCConfigurationStore extends AbstractJDBCConfigurationStor
                                +  " Using settings : " + details);
             }
 
-            String connectionPoolType = poolAttribute == null ? DefaultConnectionProviderFactory.TYPE : String.valueOf(poolAttribute);
+            String connectionPoolType = settings.getConnectionPoolType() == null ? DefaultConnectionProviderFactory.TYPE : settings.getConnectionPoolType();
 
             JDBCConnectionProviderFactory connectionProviderFactory =
                     JDBCConnectionProviderFactory.FACTORIES.get(connectionPoolType);
@@ -96,7 +93,7 @@ public class GenericJDBCConfigurationStore extends AbstractJDBCConfigurationStor
 
             try
             {
-                _connectionProvider = connectionProviderFactory.getConnectionProvider(_connectionURL, storeSettings);
+                _connectionProvider = connectionProviderFactory.getConnectionProvider(parent, _connectionURL);
             }
             catch (SQLException e)
             {
@@ -218,7 +215,7 @@ public class GenericJDBCConfigurationStore extends AbstractJDBCConfigurationStor
     private class ProvidedMessageStore extends GenericAbstractJDBCMessageStore
     {
         @Override
-        protected void doOpen(final ConfiguredObject<?> parent, final Map<String, Object> messageStoreSettings)
+        protected void doOpen(final ConfiguredObject<?> parent)
         {
             // Nothing to do, store provided by DerbyConfigurationStore
         }
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCMessageStore.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCMessageStore.java
index 680f6b5d10..aa8964f84f 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCMessageStore.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/GenericJDBCMessageStore.java
@@ -25,15 +25,12 @@ import java.sql.Blob;
 import java.sql.Connection;
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.util.Collections;
-import java.util.Map;
 
 import org.apache.log4j.Logger;
 
 import org.apache.qpid.server.model.ConfiguredObject;
 import org.apache.qpid.server.plugin.JDBCConnectionProviderFactory;
 import org.apache.qpid.server.store.StoreException;
-import org.apache.qpid.server.util.MapValueConverter;
 
 /**
  * Implementation of a MessageStore backed by a Generic JDBC Database.
@@ -43,9 +40,6 @@ public class GenericJDBCMessageStore extends GenericAbstractJDBCMessageStore
 
     private static final Logger _logger = Logger.getLogger(GenericJDBCMessageStore.class);
 
-    public static final String CONNECTION_URL = "connectionUrl";
-    public static final String CONNECTION_POOL_TYPE = "connectionPoolType";
-
     protected String _connectionURL;
     private ConnectionProvider _connectionProvider;
 
@@ -55,9 +49,10 @@ public class GenericJDBCMessageStore extends GenericAbstractJDBCMessageStore
     private boolean _useBytesMethodsForBlob;
 
     @Override
-    protected void doOpen(final ConfiguredObject<?> parent, final Map<String, Object> storeSettings) throws StoreException
+    protected void doOpen(final ConfiguredObject<?> parent) throws StoreException
     {
-        _connectionURL = String.valueOf(storeSettings.get(CONNECTION_URL));
+        JDBCSettings settings = (JDBCSettings)parent;
+        _connectionURL = settings.getConnectionUrl();
 
         JDBCDetails details = JDBCDetails.getDetailsForJdbcUrl(_connectionURL, parent.getContext());
 
@@ -77,9 +72,7 @@ public class GenericJDBCMessageStore extends GenericAbstractJDBCMessageStore
         _useBytesMethodsForBlob = details.isUseBytesMethodsForBlob();
         _bigIntType = details.getBigintType();
 
-
-        Object poolAttribute = storeSettings.get(CONNECTION_POOL_TYPE);
-        String connectionPoolType = poolAttribute == null ? DefaultConnectionProviderFactory.TYPE : String.valueOf(poolAttribute);
+        String connectionPoolType = settings.getConnectionPoolType() == null ? DefaultConnectionProviderFactory.TYPE : settings.getConnectionPoolType();
 
         JDBCConnectionProviderFactory connectionProviderFactory =
                 JDBCConnectionProviderFactory.FACTORIES.get(connectionPoolType);
@@ -92,7 +85,7 @@ public class GenericJDBCMessageStore extends GenericAbstractJDBCMessageStore
         try
         {
             // TODO: Pass parent to the connenction provider?
-            _connectionProvider = connectionProviderFactory.getConnectionProvider(_connectionURL, storeSettings);
+            _connectionProvider = connectionProviderFactory.getConnectionProvider(parent, _connectionURL);
         }
         catch (SQLException e)
         {
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/JDBCSettings.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/JDBCSettings.java
new file mode 100644
index 0000000000..3f3b53eb06
--- /dev/null
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/store/jdbc/JDBCSettings.java
@@ -0,0 +1,29 @@
+/*
+ * 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.store.jdbc;
+
+import org.apache.qpid.server.store.Settings;
+
+public interface JDBCSettings extends Settings
+{
+    String getConnectionUrl();
+
+    String getConnectionPoolType();
+}
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHost.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHost.java
index 85e8f89dbe..9f794ac707 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHost.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHost.java
@@ -1,5 +1,4 @@
 /*
- *
  * 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
@@ -16,35 +15,24 @@
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
- *
  */
-package org.apache.qpid.server.virtualhost.jdbc;
 
-import java.util.Map;
+package org.apache.qpid.server.virtualhost.jdbc;
 
-import org.apache.qpid.server.model.ManagedObject;
-import org.apache.qpid.server.model.ManagedObjectFactoryConstructor;
-import org.apache.qpid.server.model.VirtualHostNode;
-import org.apache.qpid.server.store.MessageStore;
-import org.apache.qpid.server.store.jdbc.GenericJDBCMessageStore;
-import org.apache.qpid.server.virtualhost.AbstractVirtualHost;
+import org.apache.qpid.server.exchange.ExchangeImpl;
+import org.apache.qpid.server.model.ManagedAttribute;
+import org.apache.qpid.server.queue.AMQQueue;
+import org.apache.qpid.server.store.jdbc.DefaultConnectionProviderFactory;
+import org.apache.qpid.server.store.jdbc.JDBCSettings;
+import org.apache.qpid.server.virtualhost.VirtualHostImpl;
 
-@ManagedObject(category = false, type = JDBCVirtualHost.VIRTUAL_HOST_TYPE)
-public class JDBCVirtualHost extends AbstractVirtualHost<JDBCVirtualHost>
+public interface JDBCVirtualHost<X extends JDBCVirtualHost<X>> extends VirtualHostImpl<X, AMQQueue<?>, ExchangeImpl<?>>,
+        JDBCSettings
 {
-    public static final String VIRTUAL_HOST_TYPE = "JDBC";
-
-    @ManagedObjectFactoryConstructor
-    public JDBCVirtualHost(final Map<String, Object> attributes,
-                           final VirtualHostNode<?> virtualHostNode)
-    {
-        super(attributes, virtualHostNode);
-    }
+    @ManagedAttribute(mandatory=true)
+    String getConnectionUrl();
 
+    @ManagedAttribute(defaultValue= DefaultConnectionProviderFactory.TYPE)
+    String getConnectionPoolType();
 
-    @Override
-    protected MessageStore createMessageStore()
-    {
-        return new GenericJDBCMessageStore();
-    }
 }
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHostImpl.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHostImpl.java
new file mode 100644
index 0000000000..f4e597c6a1
--- /dev/null
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhost/jdbc/JDBCVirtualHostImpl.java
@@ -0,0 +1,68 @@
+/*
+ *
+ * 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.virtualhost.jdbc;
+
+import org.apache.qpid.server.model.ManagedAttributeField;
+import org.apache.qpid.server.model.ManagedObject;
+import org.apache.qpid.server.model.ManagedObjectFactoryConstructor;
+import org.apache.qpid.server.model.VirtualHostNode;
+import org.apache.qpid.server.store.MessageStore;
+import org.apache.qpid.server.store.jdbc.GenericJDBCMessageStore;
+import org.apache.qpid.server.virtualhost.AbstractVirtualHost;
+
+import java.util.Map;
+
+@ManagedObject(category = false, type = JDBCVirtualHostImpl.VIRTUAL_HOST_TYPE)
+public class JDBCVirtualHostImpl extends AbstractVirtualHost<JDBCVirtualHostImpl> implements JDBCVirtualHost<JDBCVirtualHostImpl>
+{
+    public static final String VIRTUAL_HOST_TYPE = "JDBC";
+
+    @ManagedAttributeField
+    private String _connectionUrl;
+
+    @ManagedAttributeField
+    private String _connectionPoolType;
+
+    @ManagedObjectFactoryConstructor
+    public JDBCVirtualHostImpl(final Map<String, Object> attributes,
+                               final VirtualHostNode<?> virtualHostNode)
+    {
+        super(attributes, virtualHostNode);
+    }
+
+    @Override
+    protected MessageStore createMessageStore()
+    {
+        return new GenericJDBCMessageStore();
+    }
+
+    @Override
+    public String getConnectionUrl()
+    {
+        return _connectionUrl;
+    }
+
+    @Override
+    public String getConnectionPoolType()
+    {
+        return _connectionPoolType;
+    }
+}
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNode.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNode.java
index f9756fec65..a649dc1048 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNode.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNode.java
@@ -23,8 +23,9 @@ package org.apache.qpid.server.virtualhostnode.jdbc;
 import org.apache.qpid.server.model.ManagedAttribute;
 import org.apache.qpid.server.model.VirtualHostNode;
 import org.apache.qpid.server.store.jdbc.DefaultConnectionProviderFactory;
+import org.apache.qpid.server.store.jdbc.JDBCSettings;
 
-public interface JDBCVirtualHostNode<X extends JDBCVirtualHostNode<X>> extends VirtualHostNode<X>
+public interface JDBCVirtualHostNode<X extends JDBCVirtualHostNode<X>> extends VirtualHostNode<X>, JDBCSettings
 {
     //TODO: Split this attribute into connectionUrl, username and password. Make the password attribute secure.
     @ManagedAttribute(mandatory=true)
@@ -33,4 +34,5 @@ public interface JDBCVirtualHostNode<X extends JDBCVirtualHostNode<X>> extends V
     @ManagedAttribute(defaultValue=DefaultConnectionProviderFactory.TYPE)
     String getConnectionPoolType();
 
+    //add username and passwd managed attrs
 }
diff --git a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNodeImpl.java b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNodeImpl.java
index 9098434b69..0c51d397bf 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNodeImpl.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/main/java/org/apache/qpid/server/virtualhostnode/jdbc/JDBCVirtualHostNodeImpl.java
@@ -48,6 +48,11 @@ public class JDBCVirtualHostNodeImpl extends AbstractStandardVirtualHostNode<JDB
     }
 
     @Override
+    protected void writeLocationEventLog()
+    {
+    }
+
+    @Override
     protected DurableConfigurationStore createConfigurationStore()
     {
         return new GenericJDBCConfigurationStore();
diff --git a/qpid/java/broker-plugins/jdbc-store/src/test/java/org/apache/qpid/server/store/jdbc/JDBCMessageStoreTest.java b/qpid/java/broker-plugins/jdbc-store/src/test/java/org/apache/qpid/server/store/jdbc/JDBCMessageStoreTest.java
index 8261e93347..3f48a8fc5a 100644
--- a/qpid/java/broker-plugins/jdbc-store/src/test/java/org/apache/qpid/server/store/jdbc/JDBCMessageStoreTest.java
+++ b/qpid/java/broker-plugins/jdbc-store/src/test/java/org/apache/qpid/server/store/jdbc/JDBCMessageStoreTest.java
@@ -20,18 +20,21 @@
  */
 package org.apache.qpid.server.store.jdbc;
 
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
 import java.sql.Connection;
 import java.sql.DatabaseMetaData;
 import java.sql.DriverManager;
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.util.HashMap;
 import java.util.HashSet;
-import java.util.Map;
 import java.util.Set;
 
+import org.apache.qpid.server.model.VirtualHost;
 import org.apache.qpid.server.store.MessageStore;
 import org.apache.qpid.server.store.MessageStoreTestCase;
+import org.apache.qpid.server.virtualhost.jdbc.JDBCVirtualHost;
 
 public class JDBCMessageStoreTest extends MessageStoreTestCase
 {
@@ -61,12 +64,13 @@ public class JDBCMessageStoreTest extends MessageStoreTestCase
     }
 
     @Override
-    protected Map<String, Object> getStoreSettings()
+    protected VirtualHost createVirtualHost()
     {
         _connectionURL = "jdbc:derby:memory:/" + getTestName() + ";create=true";
-        Map<String, Object> messageStoreSettings = new HashMap<String, Object>();
-        messageStoreSettings.put(GenericJDBCMessageStore.CONNECTION_URL, _connectionURL);
-        return messageStoreSettings;
+
+        final JDBCVirtualHost jdbcVirtualHost = mock(JDBCVirtualHost.class);
+        when(jdbcVirtualHost.getConnectionUrl()).thenReturn(_connectionURL);
+        return jdbcVirtualHost;
     }