QPID-2531, QPID-2530 : Applied patches from Sorin Suciu to refactor broker-plugins directory and link new OSGi plugins to build system.

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

7 files changed, 703 insertions, 0 deletions

diff --git a/java/broker-plugins/extras/MANIFEST.MF b/java/broker-plugins/extras/MANIFEST.MF
new file mode 100644
index 0000000000..e682614ed4
--- /dev/null
+++ b/java/broker-plugins/extras/MANIFEST.MF
@@ -0,0 +1,14 @@
+Bundle-ManifestVersion: 2
+Bundle-Name: Qpid Plugins
+Bundle-Description: A simple plugin for qpid.
+Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt
+Bundle-DocURL: http://www.apache.org/
+Bundle-SymbolicName: org.apache.qpid.extras.example-plugin
+Bundle-Activator: org.apache.qpid.extras.Activator
+Private-Package: org.apache.qpid.extras,org.apache.qpid.extras.exchang
+ es.diagnostic,org.apache.qpid.extras.exchanges.example
+Import-Package: javax.management,javax.management.openmbean,org.apache
+ .qpid,org.apache.qpid.framing,org.apache.qpid.junit.extensions.util,o
+ rg.apache.qpid.protocol,org.apache.qpid.server.exchange,org.apache.qp
+ id.server.management,org.apache.qpid.server.queue,org.apache.qpid.ser
+ ver.virtualhost,org.osgi.framework;version=1.3
diff --git a/java/broker-plugins/extras/build.xml b/java/broker-plugins/extras/build.xml
new file mode 100644
index 0000000000..b8e3aa1ef2
--- /dev/null
+++ b/java/broker-plugins/extras/build.xml
@@ -0,0 +1,31 @@
+<!--
+ -
+ - Licensed to the Apache Software Foundation (ASF) under one
+nn - or more contributor license agreements.  See the NOTICE file
+ -n 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.
+ -
+ -->
+<project name="AMQ Broker-Plugins" default="build">
+
+    <property name="module.depends" value="client management/common broker common junit-toolkit"/>
+    <property name="module.manifest" value="MANIFEST.MF"/>
+    <property name="module.plugin" value="true"/>
+
+    <import file="../../module.xml"/>
+
+    <target name="bundle" depends="bundle-tasks"/>
+
+</project>
diff --git a/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/Activator.java b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/Activator.java
new file mode 100644
index 0000000000..ca6c05a435
--- /dev/null
+++ b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/Activator.java
@@ -0,0 +1,48 @@
+/*
+ *
+ * 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.extras;
+
+import org.apache.qpid.extras.exchanges.diagnostic.DiagnosticExchangeType;
+import org.apache.qpid.extras.exchanges.example.TestExchangeType;
+import org.apache.qpid.server.exchange.ExchangeType;
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+
+/**
+ * 
+ * @author aidan
+ * 
+ * Dummy class, used by PluginTest
+ */
+
+public class Activator implements BundleActivator
+{
+
+    public void start(BundleContext ctx) throws Exception
+    {
+        ctx.registerService(ExchangeType.class.getName(), new TestExchangeType(), null);
+        ctx.registerService(ExchangeType.class.getName(), new DiagnosticExchangeType(), null);
+    }
+
+    public void stop(BundleContext ctx) throws Exception
+    {
+    }
+}
diff --git a/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchange.java b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchange.java
new file mode 100644
index 0000000000..b497f192d6
--- /dev/null
+++ b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchange.java
@@ -0,0 +1,239 @@
+/*
+ *
+ * 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.extras.exchanges.diagnostic;
+
+import java.util.ArrayList;
+import java.util.Map;
+
+import javax.management.JMException;
+import javax.management.openmbean.OpenDataException;
+import javax.management.openmbean.TabularData;
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.exchange.ExchangeDefaults;
+import org.apache.qpid.framing.AMQShortString;
+import org.apache.qpid.framing.FieldTable;
+import org.apache.qpid.server.exchange.AbstractExchange;
+import org.apache.qpid.server.exchange.AbstractExchangeMBean;
+import org.apache.qpid.server.exchange.ExchangeType;
+import org.apache.qpid.server.exchange.Exchange;
+import org.apache.qpid.server.queue.AMQQueue;
+import org.apache.qpid.server.message.InboundMessage;
+import org.apache.qpid.server.binding.Binding;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+import org.apache.qpid.junit.extensions.util.SizeOf;
+import org.apache.qpid.management.common.mbeans.annotations.MBeanConstructor;
+import org.apache.qpid.management.common.mbeans.annotations.MBeanDescription;
+import org.apache.log4j.Logger;
+
+/**
+ *
+ * This is a special diagnostic exchange type which doesn't actually do anything
+ * with messages. When it receives a message, it writes information about the
+ * current memory usage to the "memory" property of the message and places it on the
+ * diagnosticqueue for retrieval
+ *
+ * @author Aidan Skinner
+ *
+ */
+
+public class DiagnosticExchange extends AbstractExchange
+{
+
+    private static final Logger _logger = Logger.getLogger(DiagnosticExchange.class);
+
+
+    public static final AMQShortString DIAGNOSTIC_EXCHANGE_CLASS = new AMQShortString("x-diagnostic");
+    public static final AMQShortString DIAGNOSTIC_EXCHANGE_NAME = new AMQShortString("diagnostic");
+
+    /**
+     * the logger.
+     */
+   //private static final Logger _logger = Logger.getLogger(DiagnosticExchange.class);
+
+    /**
+     * MBean class implementing the management interfaces.
+     */
+    @MBeanDescription("Management Bean for Diagnostic Exchange")
+    private final class DiagnosticExchangeMBean extends AbstractExchangeMBean<DiagnosticExchange>
+    {
+
+        /**
+         * Usual constructor.
+         *
+         * @throws JMException
+         */
+        @MBeanConstructor("Creates an MBean for AMQ Diagnostic exchange")
+        public DiagnosticExchangeMBean() throws JMException
+        {
+            super(DiagnosticExchange.this);
+
+            init();
+        }
+
+        /**
+         * Returns nothing, there can be no tabular data for this...
+         *
+         * @throws OpenDataException
+         * @returns null
+         * @todo ... or can there? Could this actually return all the
+         *       information in one easy to read table?
+         */
+        public TabularData bindings() throws OpenDataException
+        {
+            return null;
+        }
+
+        /**
+         * This exchange type doesn't support queues, so this method does
+         * nothing.
+         *
+         * @param queueName
+         *            the queue you'll fail to create
+         * @param binding
+         *            the binding you'll fail to create
+         * @throws JMException
+         *             an exception that will never be thrown
+         */
+        public void createNewBinding(String queueName, String binding) throws JMException
+        {
+            // No Op
+        }
+
+    } // End of MBean class
+
+
+    public static final ExchangeType<DiagnosticExchange> TYPE = new ExchangeType<DiagnosticExchange>()
+    {
+
+        public AMQShortString getName()
+        {
+            return DIAGNOSTIC_EXCHANGE_CLASS;
+        }
+
+        public Class<DiagnosticExchange> getExchangeClass()
+        {
+            return DiagnosticExchange.class;
+        }
+
+        public DiagnosticExchange newInstance(VirtualHost host,
+                                            AMQShortString name,
+                                            boolean durable,
+                                            int ticket,
+                                            boolean autoDelete) throws AMQException
+        {
+            DiagnosticExchange exch = new DiagnosticExchange();
+            exch.initialise(host,name,durable,ticket,autoDelete);
+            return exch;
+        }
+
+        public AMQShortString getDefaultExchangeName()
+        {
+            return DIAGNOSTIC_EXCHANGE_NAME ;
+        }
+    };
+
+    public DiagnosticExchange()
+    {
+        super(TYPE);
+    }
+
+    /**
+     * Creates a new MBean instance
+     *
+     * @return the newly created MBean
+     * @throws AMQException
+     *             if something goes wrong
+     */
+    protected AbstractExchangeMBean createMBean() throws JMException
+    {
+        return new DiagnosticExchange.DiagnosticExchangeMBean();
+
+    }
+
+    public Logger getLogger()
+    {
+        return _logger;
+    }
+
+    public void registerQueue(String routingKey, AMQQueue queue, Map<String, Object> args) throws AMQException
+    {
+        // No op
+    }
+
+
+    public boolean isBound(AMQShortString routingKey, AMQQueue queue)
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQShortString routingKey)
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQQueue queue)
+    {
+        return false;
+    }
+
+    public boolean hasBindings()
+    {
+        return false;
+    }
+
+    public ArrayList<AMQQueue> doRoute(InboundMessage payload)
+    {
+
+        Long value = new Long(SizeOf.getUsedMemory());
+        AMQShortString key = new AMQShortString("memory");
+
+        //TODO shouldn't modify messages... perhaps put a new message on the queue?
+/*        FieldTable headers = ((BasicContentHeaderProperties)payload.getMessageHeader().properties).getHeaders();
+        headers.put(key, value);
+        ((BasicContentHeaderProperties)payload.getMessageHeader().properties).setHeaders(headers);*/
+        AMQQueue q = getQueueRegistry().getQueue(new AMQShortString("diagnosticqueue"));
+
+        ArrayList<AMQQueue> queues =  new ArrayList<AMQQueue>();
+        queues.add(q);
+        return queues;
+
+    }
+
+
+	public boolean isBound(AMQShortString routingKey, FieldTable arguments,
+			AMQQueue queue) {
+		// TODO Auto-generated method stub
+		return false;
+	}
+
+
+    protected void onBind(final Binding binding)
+    {
+
+    }
+
+    protected void onUnbind(final Binding binding)
+    {
+
+    }
+}
diff --git a/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchangeType.java b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchangeType.java
new file mode 100644
index 0000000000..b4d0d1aa0d
--- /dev/null
+++ b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/diagnostic/DiagnosticExchangeType.java
@@ -0,0 +1,57 @@
+/*
+ *
+ * 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.extras.exchanges.diagnostic;
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.framing.AMQShortString;
+import org.apache.qpid.server.exchange.ExchangeType;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+/**
+ * Exchange type class for getting hold of the exchange.
+ */
+public final class DiagnosticExchangeType implements ExchangeType<DiagnosticExchange>
+{
+
+    public AMQShortString getName()
+    {
+        return DiagnosticExchange.DIAGNOSTIC_EXCHANGE_CLASS;
+    }
+
+    public Class<DiagnosticExchange> getExchangeClass()
+    {
+        return DiagnosticExchange.class;
+    }
+
+    public DiagnosticExchange newInstance(VirtualHost host, AMQShortString name, boolean durable, int ticket, boolean autoDelete)
+            throws AMQException
+    {
+        DiagnosticExchange exch = new DiagnosticExchange();
+        exch.initialise(host, name, durable, ticket, autoDelete);
+        return exch;
+    }
+
+    public AMQShortString getDefaultExchangeName()
+    {
+        return DiagnosticExchange.DIAGNOSTIC_EXCHANGE_NAME;
+    }
+}
diff --git a/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchange.java b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchange.java
new file mode 100644
index 0000000000..ace30b9b89
--- /dev/null
+++ b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchange.java
@@ -0,0 +1,257 @@
+package org.apache.qpid.extras.exchanges.example;
+/*
+ *
+ * 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.
+ *
+ */
+
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.framing.AMQShortString;
+import org.apache.qpid.framing.FieldTable;
+import org.apache.qpid.server.binding.Binding;
+import org.apache.qpid.server.configuration.ConfiguredObject;
+import org.apache.qpid.server.configuration.ExchangeConfigType;
+import org.apache.qpid.server.configuration.VirtualHostConfig;
+import org.apache.qpid.server.exchange.Exchange;
+import org.apache.qpid.server.exchange.ExchangeReferrer;
+import org.apache.qpid.server.exchange.ExchangeType;
+import org.apache.qpid.server.message.InboundMessage;
+import org.apache.qpid.server.queue.AMQQueue;
+import org.apache.qpid.server.queue.BaseQueue;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Map;
+import java.util.UUID;
+
+public class TestExchange implements Exchange
+{
+
+    public void close() throws AMQException
+    {
+    }
+
+
+
+    public void addBindingListener(final BindingListener listener)
+    {
+        //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public void removeBindingListener(final BindingListener listener)
+    {
+        //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public AMQShortString getNameShortString()
+    {
+        return null;
+    }
+
+    public AMQShortString getTypeShortString()
+    {
+        return null;
+    }
+
+    public boolean hasBindings()
+    {
+        return false;
+    }
+
+    public boolean isBound(String bindingKey, AMQQueue queue)
+    {
+        return false;
+    }
+
+    public boolean isBound(String bindingKey)
+    {
+        return false;
+    }
+
+    public void addCloseTask(final Task task)
+    {
+
+    }
+
+    public void removeCloseTask(final Task task)
+    {
+
+    }
+
+    public Exchange getAlternateExchange()
+    {
+        return null;
+    }
+
+    public Map<String, Object> getArguments()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getBindingCount()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getBindingCountHigh()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getMsgReceives()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getMsgRoutes()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getByteReceives()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getByteRoutes()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public long getCreateTime()
+    {
+        return 0;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public void setAlternateExchange(Exchange exchange)
+    {
+
+    }
+
+    public void removeReference(ExchangeReferrer exchange)
+    {
+
+    }
+
+    public void addReference(ExchangeReferrer exchange)
+    {
+
+    }
+
+    public boolean hasReferrers()
+    {
+        return false;
+    }
+
+    public void addBinding(final Binding binding)
+    {
+
+    }
+
+    public void removeBinding(final Binding binding)
+    {
+
+    }
+
+    public Collection<Binding> getBindings()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public void initialise(VirtualHost host, AMQShortString name, boolean durable, boolean autoDelete)
+            throws AMQException
+    {
+    }
+
+    public VirtualHostConfig getVirtualHost()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public String getName()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public ExchangeType getType()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public boolean isAutoDelete()
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQShortString routingKey, FieldTable arguments, AMQQueue queue)
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQShortString routingKey, AMQQueue queue)
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQShortString routingKey)
+    {
+        return false;
+    }
+
+    public boolean isBound(AMQQueue queue)
+    {
+        return false;
+    }
+
+    public UUID getId()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public ExchangeConfigType getConfigType()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public ConfiguredObject getParent()
+    {
+        return null;  //To change body of implemented methods use File | Settings | File Templates.
+    }
+
+    public boolean isDurable()
+    {
+        return false;
+    }
+
+    public ArrayList<? extends BaseQueue> route(InboundMessage message)
+    {
+        return new ArrayList<AMQQueue>();
+    }
+
+    public int getTicket()
+    {
+        return 0;
+    }
+
+    public void initialise(VirtualHost arg0, AMQShortString arg1, boolean arg2, int arg3, boolean arg4)
+            throws AMQException
+    {
+    }
+}
diff --git a/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchangeType.java b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchangeType.java
new file mode 100644
index 0000000000..db02ca13ea
--- /dev/null
+++ b/java/broker-plugins/extras/src/main/java/org/apache/qpid/extras/exchanges/example/TestExchangeType.java
@@ -0,0 +1,57 @@
+/*
+ *
+ * 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.extras.exchanges.example;
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.framing.AMQShortString;
+import org.apache.qpid.server.exchange.Exchange;
+import org.apache.qpid.server.exchange.ExchangeType;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+public class TestExchangeType implements ExchangeType
+{
+
+    public Class getExchangeClass()
+    {
+        return TestExchange.class;
+    }
+
+    public AMQShortString getName()
+    {
+        return null;
+    }
+
+    public Exchange newInstance(VirtualHost host, AMQShortString name, boolean durable,
+                                int token, boolean autoDelete)
+            throws AMQException
+    {
+        TestExchange ex = new TestExchange();
+        ex.initialise(host, name, durable, token, autoDelete);
+        return ex;
+    }
+
+    public AMQShortString getDefaultExchangeName()
+    {
+        return new AMQShortString("test.exchange");
+    }
+
+}