From 61c9466ff91ca40f4b1ebbe670d7848e521131d7 Mon Sep 17 00:00:00 2001 From: lresende Date: Wed, 11 Nov 2009 23:08:20 +0000 Subject: Moving 1.x branches git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@835130 13f79535-47bb-0310-9956-ffa450edef68 --- .../sca/core/DefaultExtensionPointRegistry.java | 184 ++++++++++++ .../core/DefaultModuleActivatorExtensionPoint.java | 92 ++++++ .../sca/core/DefaultUtilityExtensionPoint.java | 184 ++++++++++++ .../tuscany/sca/core/ExtensionPointRegistry.java | 56 ++++ .../apache/tuscany/sca/core/ModuleActivator.java | 60 ++++ .../sca/core/ModuleActivatorExtensionPoint.java | 53 ++++ .../tuscany/sca/core/UtilityExtensionPoint.java | 54 ++++ .../sca/extensibility/ServiceDeclaration.java | 136 +++++++++ .../sca/extensibility/ServiceDiscovery.java | 318 +++++++++++++++++++++ 9 files changed, 1137 insertions(+) create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultModuleActivatorExtensionPoint.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivator.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDeclaration.java create mode 100644 sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDiscovery.java (limited to 'sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany') diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java new file mode 100644 index 0000000000..48f240559c --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java @@ -0,0 +1,184 @@ +/* + * 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.core; + +import java.io.IOException; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Modifier; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; + +/** + * Default implementation of a registry to hold all the Tuscany core extension + * points. As the point of contact for all extension artifacts this registry + * allows loaded extensions to find all other parts of the system and register + * themselves appropriately. + * + * @version $Rev$ $Date$ + */ +public class DefaultExtensionPointRegistry implements ExtensionPointRegistry { + private Map, Object> extensionPoints = new HashMap, Object>(); + + /** + * Constructs a new registry. + */ + public DefaultExtensionPointRegistry() { + } + + /** + * Add an extension point to the registry. This default implementation + * stores extensions against the interfaces that they implement. + * + * @param extensionPoint The instance of the extension point + * + * @throws IllegalArgumentException if extensionPoint is null + */ + public void addExtensionPoint(Object extensionPoint) { + if (extensionPoint == null) { + throw new IllegalArgumentException("Cannot register null as an ExtensionPoint"); + } + + Set> interfaces = getAllInterfaces(extensionPoint.getClass()); + for (Class i : interfaces) { + extensionPoints.put(i, extensionPoint); + } + } + + private Constructor getConstructor(Constructor[] constructors, Class[] paramTypes) { + for (Constructor c : constructors) { + Class[] types = c.getParameterTypes(); + if (c.getParameterTypes().length == paramTypes.length) { + boolean found = true; + for (int i = 0; i < types.length; i++) { + if (types[i] != paramTypes[i]) { + found = false; + break; + } + } + if (found) { + return c; + } + } + } + return null; + } + + /** + * Get the extension point by the interface that it implements + * + * @param extensionPointType The lookup key (extension point interface) + * @return The instance of the extension point + * + * @throws IllegalArgumentException if extensionPointType is null + */ + public T getExtensionPoint(Class extensionPointType) { + if (extensionPointType == null) { + throw new IllegalArgumentException("Cannot lookup ExtensionPoint of type null"); + } + + Object extensionPoint = extensionPoints.get(extensionPointType); + if (extensionPoint == null) { + + // Dynamically load an extension point class declared under META-INF/services + try { + Class extensionPointClass = + ServiceDiscovery.getInstance().loadFirstServiceClass(extensionPointType); + if (extensionPointClass != null) { + // Construct the extension point + Constructor[] constructors = extensionPointClass.getConstructors(); + Constructor constructor = getConstructor(constructors, new Class[] {ExtensionPointRegistry.class}); + if (constructor != null) { + extensionPoint = constructor.newInstance(this); + } else { + constructor = getConstructor(constructors, new Class[] {}); + if (constructor != null) { + extensionPoint = constructor.newInstance(); + } else { + throw new IllegalArgumentException( + "No valid constructor is found for " + extensionPointClass); + } + } + + // Cache the loaded extension point + addExtensionPoint(extensionPoint); + } + } catch (InvocationTargetException e) { + throw new IllegalArgumentException(e); + } catch (IOException e) { + throw new IllegalArgumentException(e); + } catch (ClassNotFoundException e) { + throw new IllegalArgumentException(e); + } catch (InstantiationException e) { + throw new IllegalArgumentException(e); + } catch (IllegalAccessException e) { + throw new IllegalArgumentException(e); + } + } + return extensionPointType.cast(extensionPoint); + } + + /** + * Remove an extension point based on the interface that it implements + * + * @param extensionPoint The extension point to remove + * + * @throws IllegalArgumentException if extensionPoint is null + */ + public void removeExtensionPoint(Object extensionPoint) { + if (extensionPoint == null) { + throw new IllegalArgumentException("Cannot remove null as an ExtensionPoint"); + } + + Set> interfaces = getAllInterfaces(extensionPoint.getClass()); + for (Class i : interfaces) { + extensionPoints.remove(i); + } + } + + /** + * Returns the set of interfaces implemented by the given class and its + * ancestors or a blank set if none + */ + private static Set> getAllInterfaces(Class clazz) { + Set> implemented = new HashSet>(); + getAllInterfaces(clazz, implemented); + return implemented; + } + + private static void getAllInterfaces(Class clazz, Set> implemented) { + Class[] interfaces = clazz.getInterfaces(); + for (Class interfaze : interfaces) { + if (Modifier.isPublic(interfaze.getModifiers())) { + implemented.add(interfaze); + } + } + Class superClass = clazz.getSuperclass(); + // Object has no superclass so check for null + if (superClass != null && !superClass.equals(Object.class)) { + getAllInterfaces(superClass, implemented); + } + } + +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultModuleActivatorExtensionPoint.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultModuleActivatorExtensionPoint.java new file mode 100644 index 0000000000..8ca030c0dd --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultModuleActivatorExtensionPoint.java @@ -0,0 +1,92 @@ +/* + * 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.core; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Set; + +import org.apache.tuscany.sca.extensibility.ServiceDeclaration; +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; + +/** + * Default implementation of an extension point to hold Tuscany module activators. + * + * @version $Rev$ $Date$ + */ +public class DefaultModuleActivatorExtensionPoint implements ModuleActivatorExtensionPoint { + private List activators = new ArrayList(); + private boolean loadedActivators; + + /** + * Constructs a new extension point. + */ + public DefaultModuleActivatorExtensionPoint() { + } + + public void addModuleActivator(ModuleActivator activator) { + activators.add(activator); + } + + public List getModuleActivators() { + loadModuleActivators(); + return activators; + } + + public void removeModuleActivator(Object activator) { + activators.remove(activator); + } + + /** + * Dynamically load module activators declared under META-INF/services + */ + private void loadModuleActivators() { + if (loadedActivators) + return; + + // Get the activator service declarations + Set activatorDeclarations; + try { + activatorDeclarations = ServiceDiscovery.getInstance().getServiceDeclarations(ModuleActivator.class); + } catch (IOException e) { + throw new IllegalStateException(e); + } + + // Load and instantiate module activators + for (ServiceDeclaration activatorDeclaration: activatorDeclarations) { + ModuleActivator activator; + try { + Class activatorClass = (Class)activatorDeclaration.loadClass(); + activator = activatorClass.newInstance(); + } catch (ClassNotFoundException e) { + throw new IllegalArgumentException(e); + } catch (InstantiationException e) { + throw new IllegalArgumentException(e); + } catch (IllegalAccessException e) { + throw new IllegalArgumentException(e); + } + addModuleActivator(activator); + } + + loadedActivators = true; + } + +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java new file mode 100644 index 0000000000..6f7c83c8d9 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/DefaultUtilityExtensionPoint.java @@ -0,0 +1,184 @@ +/* + * 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.core; + +import java.io.IOException; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Modifier; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; + +/** + * Default implementation of an extension point to hold Tuscany utility utilities. + * + * @version $Rev$ $Date$ + */ +public class DefaultUtilityExtensionPoint implements UtilityExtensionPoint { + private Map, Object> utilities = new HashMap, Object>(); + + private ExtensionPointRegistry extensionPoints; + + /** + * Constructs a new extension point. + */ + public DefaultUtilityExtensionPoint(ExtensionPointRegistry extensionPoints) { + this.extensionPoints = extensionPoints; + } + + /** + * Add a utility to the extension point. This default implementation + * stores utilities against the interfaces that they implement. + * + * @param utility The instance of the utility + * + * @throws IllegalArgumentException if utility is null + */ + public void addUtility(Object utility) { + if (utility == null) { + throw new IllegalArgumentException("Cannot register null as a Service"); + } + + Set> interfaces = getAllInterfaces(utility.getClass()); + for (Class i : interfaces) { + utilities.put(i, utility); + } + } + + private Constructor getConstructor(Constructor[] constructors, Class[] paramTypes) { + for (Constructor c : constructors) { + Class[] types = c.getParameterTypes(); + if (c.getParameterTypes().length == paramTypes.length) { + boolean found = true; + for (int i = 0; i < types.length; i++) { + if (types[i] != paramTypes[i]) { + found = false; + break; + } + } + if (found) { + return c; + } + } + } + return null; + } + + /** + * Get the utility by the interface that it implements + * + * @param utilityType The lookup key (utility interface) + * @return The instance of the utility + * + * @throws IllegalArgumentException if utilityType is null + */ + public T getUtility(Class utilityType) { + if (utilityType == null) { + throw new IllegalArgumentException("Cannot lookup Service of type null"); + } + + Object utility = utilities.get(utilityType); + if (utility == null) { + + // Dynamically load a utility class declared under META-INF/utilities + try { + Class utilityClass = + ServiceDiscovery.getInstance().loadFirstServiceClass(utilityType); + if (utilityClass != null) { + // Construct the utility + Constructor[] constructors = utilityClass.getConstructors(); + Constructor constructor = getConstructor(constructors, new Class[] {ExtensionPointRegistry.class}); + if (constructor != null) { + utility = constructor.newInstance(extensionPoints); + } else { + constructor = getConstructor(constructors, new Class[] {}); + if (constructor != null) { + utility = constructor.newInstance(); + } else { + throw new IllegalArgumentException( + "No valid constructor is found for " + utilityClass); + } + } + + // Cache the loaded utility + addUtility(utility); + } + } catch (InvocationTargetException e) { + throw new IllegalArgumentException(e); + } catch (IOException e) { + throw new IllegalArgumentException(e); + } catch (ClassNotFoundException e) { + throw new IllegalArgumentException(e); + } catch (InstantiationException e) { + throw new IllegalArgumentException(e); + } catch (IllegalAccessException e) { + throw new IllegalArgumentException(e); + } + } + return utilityType.cast(utility); + } + + /** + * Remove a utility based on the interface that it implements + * + * @param utility The utility to remove + * + * @throws IllegalArgumentException if utility is null + */ + public void removeUtility(Object utility) { + if (utility == null) { + throw new IllegalArgumentException("Cannot remove null as a Service"); + } + + Set> interfaces = getAllInterfaces(utility.getClass()); + for (Class i : interfaces) { + utilities.remove(i); + } + } + + /** + * Returns the set of interfaces implemented by the given class and its + * ancestors or a blank set if none + */ + private static Set> getAllInterfaces(Class clazz) { + Set> implemented = new HashSet>(); + getAllInterfaces(clazz, implemented); + return implemented; + } + + private static void getAllInterfaces(Class clazz, Set> implemented) { + Class[] interfaces = clazz.getInterfaces(); + for (Class interfaze : interfaces) { + if (Modifier.isPublic(interfaze.getModifiers())) { + implemented.add(interfaze); + } + } + Class superClass = clazz.getSuperclass(); + // Object has no superclass so check for null + if (superClass != null && !superClass.equals(Object.class)) { + getAllInterfaces(superClass, implemented); + } + } + +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java new file mode 100644 index 0000000000..f2f67b2d52 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java @@ -0,0 +1,56 @@ +/* + * 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.core; + + +/** + * The registry for the Tuscany core extension points. As the point of contact + * for all extension artifacts this registry allows loaded extensions to find + * all other parts of the system and register themselves appropriately. + * + * @version $Rev$ $Date$ + */ +public interface ExtensionPointRegistry { + + /** + * Add an extension point to the registry + * @param extensionPoint The instance of the extension point + * + * @throws IllegalArgumentException if extensionPoint is null + */ + void addExtensionPoint(Object extensionPoint); + + /** + * Get the extension point by the interface + * @param extensionPointType The lookup key (extension point interface) + * @return The instance of the extension point + * + * @throws IllegalArgumentException if extensionPointType is null + */ + T getExtensionPoint(Class extensionPointType); + + /** + * Remove an extension point + * @param extensionPoint The extension point to remove + * + * @throws IllegalArgumentException if extensionPoint is null + */ + void removeExtensionPoint(Object extensionPoint); +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivator.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivator.java new file mode 100644 index 0000000000..dbfd0dcd90 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivator.java @@ -0,0 +1,60 @@ +/* + * 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.core; + + +/** + * ModuleActivator represents a module that plugs into the Tuscany system. Each + * module should provide an implementation of this interface and register the + * ModuleActivator implementation class by defining a file named + * + * "META-INF/services/org.apache.tuscany.core.ModuleActivator" + * + * The content of the file is the class name of the ModuleActivator implementation. + * The implementation class must have a no-arg constructor. The same instance + * will be used to invoke all the methods during different phases of the module + * activation. Note that the start and stop methods defined by this interface + * take a reference to the Tuscany SCA runtime ExtensionPointRegistry. This + * gives the ModuleActivator the opportunity to add extension points to the + * registry as it is requested to start up and remove them when it is requested + * to shut down. + * + * @version $Rev$ $Date$ + */ +public interface ModuleActivator { + + /** + * This method is invoked when the module is started by the Tuscany system. + * It can be used by this module to register extensions against extension + * points. + * + * @param registry The extension point registry + */ + void start(ExtensionPointRegistry registry); + + /** + * This method is invoked when the module is stopped by the Tuscany system. + * It can be used by this module to unregister extensions against the + * extension points. + * + * @param registry The extension point registry + */ + void stop(ExtensionPointRegistry registry); +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.java new file mode 100644 index 0000000000..ec0f12b8ba --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.java @@ -0,0 +1,53 @@ +/* + * 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.core; + +import java.util.List; + + +/** + * The extension point for the Tuscany module activator extensions. + * + * @version $Rev$ $Date$ + */ +public interface ModuleActivatorExtensionPoint { + + /** + * Add a module activator extension to the extension point + * @param activator The instance of the module activator + * + * @throws IllegalArgumentException if activator is null + */ + void addModuleActivator(ModuleActivator activator); + + /** + * Returns the module activator extensions. + * @return The module activator extensions + */ + List getModuleActivators(); + + /** + * Remove a module activator + * @param activator The module activator to remove + * + * @throws IllegalArgumentException if activator is null + */ + void removeModuleActivator(Object activator); +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java new file mode 100644 index 0000000000..6b14b95666 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/core/UtilityExtensionPoint.java @@ -0,0 +1,54 @@ +/* + * 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.core; + + +/** + * The extension point for the Tuscany core utility extensions. + * + * @version $Rev$ $Date$ + */ +public interface UtilityExtensionPoint { + + /** + * Add a utility to the extension point + * @param utility The instance of the utility + * + * @throws IllegalArgumentException if utility is null + */ + void addUtility(Object utility); + + /** + * Get the utility by the interface + * @param utilityType The lookup key (utility interface) + * @return The instance of the utility + * + * @throws IllegalArgumentException if utilityType is null + */ + T getUtility(Class utilityType); + + /** + * Remove a utility + * @param utility The utility to remove + * + * @throws IllegalArgumentException if utility is null + */ + void removeUtility(Object utility); +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDeclaration.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDeclaration.java new file mode 100644 index 0000000000..4b25f2adc2 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDeclaration.java @@ -0,0 +1,136 @@ +/* + * 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.lang.ref.WeakReference; +import java.net.URL; +import java.util.Map; + +/** + * Service declaration using J2SE Jar service provider spec Classes specified + * inside this declaration are loaded using the ClassLoader used to read the + * configuration file corresponding to this declaration. + * + * @version $Rev$ $Date$ + */ +public class ServiceDeclaration { + + private WeakReference classLoader; + + private String className; + + private Map attributes; + + /** + * Service declaration constructor + * + * @param className Service implementation class name + * @param classLoader ClassLoader corresponding to this service + * implementation + * @param attributes Optional attributes for this service declaration + */ + public ServiceDeclaration(String className, ClassLoader classLoader, Map attributes) { + + this.className = className; + this.classLoader = new WeakReference(classLoader); + this.attributes = attributes; + } + + /** + * Load this service implementation class + * + * @return Class + * @throws ClassNotFoundException + */ + @SuppressWarnings("unchecked") + public Class loadClass() throws ClassNotFoundException { + + return Class.forName(className, true, classLoader.get()); + } + + /** + * Load another class using the ClassLoader of this service implementation + * + * @param anotherClassName + * @return Class + * @throws ClassNotFoundException + */ + public Class loadClass(String anotherClassName) throws ClassNotFoundException { + + return Class.forName(anotherClassName, true, classLoader.get()); + } + + /** + * Return the resource corresponding to this service implementation class + * + * @return resource URL + */ + public URL getResource() { + return classLoader.get().getResource(className); + } + + /** + * ClassLoader associated with this service declaration + * + * @return ClassLoader + */ + public ClassLoader getClassLoader() { + return classLoader.get(); + } + + /** + * Service implementation class corresponding to this declaration + * + * @return The Service implementation class corresponding to this declaration + */ + public String getClassName() { + return className; + } + + /** + * Attributes specified for this declaration + * + * @return attributes + */ + public Map getAttributes() { + return attributes; + } + + /** + * Equals method used to ensure that each service declaration is stored only + * once in a set of declarations. + */ + @Override + public boolean equals(Object o) { + if (!(o instanceof ServiceDeclaration)) + return false; + ServiceDeclaration s = (ServiceDeclaration)o; + if (!className.equals(s.className)) + return false; + else if (!classLoader.equals(s.classLoader)) + return false; + else if (attributes == null) + return s.attributes == null; + else + return attributes.equals(s.attributes); + + } + +} diff --git a/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDiscovery.java b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDiscovery.java new file mode 100644 index 0000000000..3e702ea5db --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.3.3/modules/extensibility/src/main/java/org/apache/tuscany/sca/extensibility/ServiceDiscovery.java @@ -0,0 +1,318 @@ +/* + * 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.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.net.URL; +import java.net.URLConnection; +import java.security.AccessController; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Hashtable; +import java.util.Map; +import java.util.Set; +import java.util.StringTokenizer; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * Service discovery for Tuscany based on J2SE Jar service provider spec. + * Services are described using configuration files in META-INF/services. + * Service description specifies a class name followed by optional properties. + * Multi-ClassLoader environments are supported through a ClassLoader + * registration API + * + * @version $Rev$ $Date$ + */ +public class ServiceDiscovery { + private static final Logger logger = Logger.getLogger(ServiceDiscovery.class.getName()); + + private static ServiceDiscovery instance; + + private HashSet registeredClassLoaders; + + /** + * Get an instance of Service discovery, one instance is created per + * ClassLoader that this class is loaded from + * + * @return + */ + public static ServiceDiscovery getInstance() { + + if (instance == null) { + instance = new ServiceDiscovery(); + instance.registeredClassLoaders = new HashSet(); + instance.registeredClassLoaders.add(ServiceDiscovery.class.getClassLoader()); + } + return instance; + } + + /** + * Register a ClassLoader with this discovery mechanism. Tuscany extension + * ClassLoaders are registered here. + * + * @param classLoader + */ + public synchronized void registerClassLoader(ClassLoader classLoader) { + registeredClassLoaders.add(classLoader); + } + + /** + * Unregister a ClassLoader with this discovery mechanism. + * + * @param classLoader + */ + public synchronized void unregisterClassLoader(ClassLoader classLoader) { + registeredClassLoaders.remove(classLoader); + } + + /** + * Get all service declarations for this name + * + * @param name + * @return set of service declarations + * @throws IOException + */ + public synchronized Set getServiceDeclarations(String name) throws IOException { + + Set classSet = new HashSet(); + + for (ClassLoader classLoader : registeredClassLoaders) { + getServiceClasses(classLoader, name, classSet, true); + } + return classSet; + } + + /** + * Get all service declarations for this interface + * + * @param serviceInterface + * @return set of service declarations + * @throws IOException + */ + public Set getServiceDeclarations(Class serviceInterface) throws IOException { + + return getServiceDeclarations(serviceInterface.getName()); + } + + /** + * Load one service implementation class for this interface + * + * @param serviceInterface + * @return service implementation class + * @throws IOException + * @throws ClassNotFoundException + */ + public synchronized Class loadFirstServiceClass(Class serviceInterface) throws IOException, ClassNotFoundException { + + Set classSet = new HashSet(); + + for (ClassLoader classLoader : registeredClassLoaders) { + getServiceClasses(classLoader, serviceInterface.getName(), classSet, false); + if (classSet.size() > 0) + break; + } + if (classSet.size() > 0) + return classSet.iterator().next().loadClass(); + else + return null; + + } + + /** + * Returns a unique list of resource URLs of name META-INF/services/ + * Each URL is associated with the first ClassLoader that it was visible + * from + * + * @param name Name of resource + * @return Table of URLs with associated ClassLoaders + * @throws IOException + */ + public synchronized Hashtable> getServiceResources(final String name) throws IOException { + + Hashtable> resourceTable = new Hashtable>(); + + HashSet allURLs = new HashSet(); + for (final ClassLoader classLoader : registeredClassLoaders) { + HashSet urls = new HashSet(); + resourceTable.put(classLoader, urls); + boolean debug = logger.isLoggable(Level.FINE); + if (debug) { + logger.fine("Discovering service resources using class loader " + classLoader); + } + // Allow privileged access to read META-INF/services/*. Add FilePermission to added to security policy file. + ArrayList urlList; + try { + // FIXME J2 Security - promote this to callers of this method + urlList = AccessController.doPrivileged(new PrivilegedExceptionAction>() { + public ArrayList run() throws IOException { + return Collections.list(classLoader.getResources("META-INF/services/" + name)); + } + }); + } catch (PrivilegedActionException e) { + throw (IOException)e.getException(); + } + + for (URL url : urlList) { + if (allURLs.contains(url)) + continue; + urls.add(url); + } + allURLs.addAll(urls); + } + return resourceTable; + } + + /** + * Parse a service declaration in the form class;attr=value,attr=value and + * return a map of attributes + * + * @param declaration + * @return a map of attributes + */ + private Map parseServiceDeclaration(String declaration) { + Map attributes = new HashMap(); + int index = declaration.indexOf(';'); + if (index != -1) { + attributes.put("class", declaration.substring(0, index).trim()); + declaration = declaration.substring(index); + } else { + int j = declaration.indexOf('='); + if (j == -1) { + attributes.put("class", declaration.trim()); + return attributes; + } else { + declaration = ";" + declaration; + } + } + StringTokenizer tokens = new StringTokenizer(declaration); + for (; tokens.hasMoreTokens();) { + String key = tokens.nextToken("=").substring(1).trim(); + if (key == null) + break; + String value = tokens.nextToken(",").substring(1).trim(); + if (value == null) + break; + attributes.put(key, value); + } + return attributes; + } + + /** + * Load the service class whose name specified in a configuration file + * + * @param classLoader + * @param name The name of the service class + * @param classSet Populate this set with classes extends/implements the + * service class + * @throws IOException + */ + private void getServiceClasses(final ClassLoader classLoader, + final String name, + Set classSet, + boolean findAllClasses) throws IOException { + + boolean debug = logger.isLoggable(Level.FINE); + if (debug) { + logger.fine("Discovering service providers using class loader " + classLoader); + } + // Allow privileged access to read META-INF/services/*. Add FilePermission to added to + // security policy file. + ArrayList urlList; + try { + urlList = AccessController.doPrivileged(new PrivilegedExceptionAction>() { + public ArrayList run() throws IOException { + return Collections.list(classLoader.getResources("META-INF/services/" + name)); + } + }); + } catch (PrivilegedActionException e) { + throw (IOException)e.getException(); + } + + for (final URL url : urlList) { + if (debug) { + logger.fine("Reading service provider file: " + url.toExternalForm()); + } + + // Allow privileged access to open URL stream. Add FilePermission to added to security + // policy file. + InputStream is; + try { + is = AccessController.doPrivileged(new PrivilegedExceptionAction() { + public InputStream run() throws IOException { + URLConnection connection = url.openConnection(); + // TUSCANY-2539 + // Don't cache connections by default to stop Tuscany locking contribution jar files + // done here as this is one of the first places we open a stream and the only way to + // set the default is to set it on an instance of URLConnection + connection.setDefaultUseCaches(false); + connection.setUseCaches(false); + return url.openStream(); + } + }); + } catch (PrivilegedActionException e) { + throw (IOException)e.getException(); + } + BufferedReader reader = null; + try { + reader = new BufferedReader(new InputStreamReader(is)); + while (true) { + String line = reader.readLine(); + if (line == null) + break; + line = line.trim(); + if (!line.startsWith("#") && !"".equals(line)) { + String reg = line.trim(); + if (debug) { + logger.fine("Registering service provider: " + reg); + } + + Map attributes = parseServiceDeclaration(reg); + String className = attributes.get("class"); + ServiceDeclaration serviceClass = new ServiceDeclaration(className, classLoader, attributes); + classSet.add(serviceClass); + + if (!findAllClasses) + break; + } + } + } finally { + if (reader != null) + reader.close(); + if (is != null) { + try { + is.close(); + } catch (IOException ioe) { + } + } + } + if (!findAllClasses && classSet.size() > 0) + break; + } + } + +} -- cgit v1.2.3