Add getUtility by key to UtilityExtensionPoint

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@794124 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 159 insertions, 34 deletions

diff --git a/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java b/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java
index 1004fc3019..2ab50cf414 100644
--- a/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java
+++ b/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java
@@ -23,10 +23,9 @@ import java.io.IOException;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Modifier;
-import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.IdentityHashMap;
-import java.util.List;
+import java.util.Iterator;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
@@ -40,11 +39,9 @@ import org.apache.tuscany.sca.extensibility.ServiceDiscovery;
  * @version $Rev$ $Date$
  */
 public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
-    private Map<Class<?>, Object> utilities = new ConcurrentHashMap<Class<?>, Object>();
+    private Map<Object, Object> utilities = new ConcurrentHashMap<Object, Object>();
 
     private ExtensionPointRegistry extensionPoints;
-    private List<Object> unmapped = new ArrayList<Object>();
-
     /**
      * Constructs a new extension point.
      */
@@ -61,16 +58,25 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
      * @throws IllegalArgumentException if utility is null
      */
     public void addUtility(Object utility) {
+        addUtility(null, utility);
+    }
+    
+    public void addUtility(Object key, Object utility) {
         if (utility == null) {
             throw new IllegalArgumentException("Cannot register null as a Service");
         }
 
-        if(utility instanceof LifeCycleListener) {
-            ((LifeCycleListener) utility).start();
+        if (utility instanceof LifeCycleListener) {
+            ((LifeCycleListener)utility).start();
         }
-        Set<Class<?>> interfaces = getAllInterfaces(utility.getClass());
-        for (Class<?> i : interfaces) {
-            utilities.put(i, utility);
+
+        if (key == null) {
+            Set<Class<?>> interfaces = getAllInterfaces(utility.getClass());
+            for (Class<?> i : interfaces) {
+                utilities.put(i, utility);
+            }
+        } else {
+            utilities.put(key, utility);
         }
     }
 
@@ -102,7 +108,7 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
      * @throws IllegalArgumentException if utilityType is null
      */
     public <T> T getUtility(Class<T> utilityType) {
-        return getUtility(utilityType, false);
+        return getUtility(utilityType, null);
     }
 
     /**
@@ -120,10 +126,12 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
         if(utility instanceof LifeCycleListener) {
             ((LifeCycleListener) utility).stop();
         }
-
-        Set<Class<?>> interfaces = getAllInterfaces(utility.getClass());
-        for (Class<?> i : interfaces) {
-            utilities.remove(i);
+        
+        for (Iterator<Map.Entry<Object, Object>> i = utilities.entrySet().iterator(); i.hasNext();) {
+            Map.Entry<Object, Object> entry = i.next();
+            if (entry.getValue() == utility) {
+                i.remove();
+            }
         }
     }
 
@@ -134,6 +142,7 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
     private static Set<Class<?>> getAllInterfaces(Class<?> clazz) {
         Set<Class<?>> implemented = new HashSet<Class<?>>();
         getAllInterfaces(clazz, implemented);
+        implemented.remove(LifeCycleListener.class);
         return implemented;
     }
 
@@ -151,15 +160,17 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
         }
     }
 
-    public <T> T getUtility(Class<T> utilityType, boolean newInstance) {
+    public <T> T getUtility(Class<T> utilityType, Object key) {
         if (utilityType == null) {
             throw new IllegalArgumentException("Cannot lookup Service of type null");
         }
-
-        Object utility = null;
-        if (!newInstance) {
-            utility = utilities.get(utilityType);
+        
+        if (key == null) {
+            key = utilityType;
         }
+
+        Object utility = utilities.get(key);
+   
         if (utility == null) {
 
             // Dynamically load a utility class declared under META-INF/services/"utilityType"
@@ -188,9 +199,10 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
                         }
                     }
                     // Cache the loaded utility
-                    addUtility(utility);
-                    if (newInstance) {
-                        unmapped.add(utility);
+                    if (key == utilityType) {
+                        addUtility(utility);
+                    } else {
+                        addUtility(key, utility);
                     }
                 }
             } catch (InvocationTargetException e) {
@@ -206,8 +218,7 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
             }
         }
         return utilityType.cast(utility);
-    }
-
+    }    
     public void start() {
         // NOOP
     }
@@ -221,12 +232,6 @@ public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint {
                 map.put(listener, listener);
             }
         }
-        for (Object util : unmapped) {
-            if (util instanceof LifeCycleListener) {
-                LifeCycleListener listener = (LifeCycleListener)util;
-                map.put(listener, listener);
-            }
-        }
         for (LifeCycleListener listener : map.values()) {
             listener.stop();
         }
diff --git a/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java b/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java
index 4cf1db16d1..bfeeac5696 100644
--- a/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java
+++ b/java/sca/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java
@@ -34,6 +34,14 @@ public interface UtilityExtensionPoint extends LifeCycleListener {
      * @throws IllegalArgumentException if utility is null
      */
     void addUtility(Object utility);
+    
+    /**
+     * Add a utility to the extension point for a given key
+     * @param utility The instance of the utility
+     *
+     * @throws IllegalArgumentException if utility is null
+     */
+    void addUtility(Object key, Object utility);
 
     /**
      * Get the utility by the interface
@@ -45,14 +53,15 @@ public interface UtilityExtensionPoint extends LifeCycleListener {
     <T> T getUtility(Class<T> utilityType);
 
     /**
-     * Get a new instance of the utility by the interface
+     * Get an instance of the utility by the interface and key
      * @param utilityType The lookup key (utility interface)
-     * @param newInstance A new instance is required
+     * @param key A key associated with the utility, if it is null,
+     * then the utilityType is used as the key
      * @return The instance of the utility
      *
      * @throws IllegalArgumentException if utilityType is null
      */
-    <T> T getUtility(Class<T> utilityType, boolean newInstance);
+    <T> T getUtility(Class<T> utilityType, Object key);
 
     /**
      * Remove a utility
diff --git a/java/sca/modules/extensibility/src/test/java/org/apache/tuscany/sca/extensibility/DefaultUtilityExtensionPointTestCase.java b/java/sca/modules/extensibility/src/test/java/org/apache/tuscany/sca/extensibility/DefaultUtilityExtensionPointTestCase.java
new file mode 100644
index 0000000000..7e66d44b43
--- /dev/null
+++ b/java/sca/modules/extensibility/src/test/java/org/apache/tuscany/sca/extensibility/DefaultUtilityExtensionPointTestCase.java
@@ -0,0 +1,111 @@
+/*

+ * 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.tuscany.sca.extensibility;

+

+

+import java.io.Serializable;

+

+import org.apache.tuscany.sca.core.DefaultUtilityExtensionPoint;

+import org.apache.tuscany.sca.core.LifeCycleListener;

+import org.apache.tuscany.sca.core.UtilityExtensionPoint;

+import org.junit.AfterClass;

+import org.junit.Assert;

+import org.junit.BeforeClass;

+import org.junit.Test;

+

+/**

+ * 

+ */

+public class DefaultUtilityExtensionPointTestCase {

+    private static UtilityExtensionPoint ep;

+    

+    /**

+     * @throws java.lang.Exception

+     */

+    @BeforeClass

+    public static void setUpBeforeClass() throws Exception {

+        ep = new DefaultUtilityExtensionPoint(null);

+        ep.start();

+    }

+    

+    @Test

+    public void testGet() {

+        MyUtilityImpl my = new MyUtilityImpl();

+        ep.addUtility(my);

+        Assert.assertTrue(my.started);

+        Utility1 u1 = ep.getUtility(Utility1.class);

+        Assert.assertSame(my, u1);

+        Utility2 u2 = ep.getUtility(Utility2.class);

+        Assert.assertSame(my, u2);

+        ep.removeUtility(my);

+        Assert.assertFalse(my.started);

+        u1 = ep.getUtility(Utility1.class);

+        Assert.assertNull(u1);

+        

+        ep.addUtility("1", my);

+        u1= ep.getUtility(Utility1.class);

+        Assert.assertNull(u1);

+        u1= ep.getUtility(Utility1.class, "1");

+        Assert.assertNotNull(u1);

+        ep.removeUtility(my);

+        u1= ep.getUtility(Utility1.class, "1");

+        Assert.assertNull(u1);

+    }

+

+    /**

+     * @throws java.lang.Exception

+     */

+    @AfterClass

+    public static void tearDownAfterClass() throws Exception {

+        ep.stop();

+    }

+    

+    public static interface Utility1 extends Serializable {

+        void op1();

+    }

+    

+    public static interface Utility2 extends Serializable {

+        void op2();

+    }

+    

+    public static class MyUtilityImpl implements Utility1, Utility2, LifeCycleListener {

+        public boolean started;

+        

+        public void start() {

+            System.out.println("start");

+            started = true;

+        }

+

+        public void stop() {

+            System.out.println("stop");

+            started = false;

+        }

+

+        public void op1() {

+            System.out.println("op1");

+        }

+        

+        public void op2() {

+            System.out.println("op2");

+        }

+        

+    }

+

+}