diff options
Diffstat (limited to '')
4 files changed, 527 insertions, 0 deletions
diff --git a/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoverer.java b/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoverer.java new file mode 100644 index 0000000000..a536684b2e --- /dev/null +++ b/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoverer.java @@ -0,0 +1,359 @@ +/* + * 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.osgi; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.net.URL; +import java.security.AccessController; +import java.security.PrivilegedAction; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; +import java.security.SecureClassLoader; +import java.util.Collections; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.StringTokenizer; +import java.util.logging.Level; +import java.util.logging.Logger; + +import org.apache.tuscany.sca.extensibility.ServiceDeclaration; +import org.apache.tuscany.sca.extensibility.ServiceDiscoverer; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleContext; + +/** + * The ServiceDiscoverer that find META-INF/services/... in installed bundles + */ +public class OSGiServiceDiscoverer implements ServiceDiscoverer { + private static final Logger logger = Logger.getLogger(OSGiServiceDiscoverer.class.getName()); + private BundleContext context; + private ClassLoader classLoader; + + public OSGiServiceDiscoverer(BundleContext context) { + this.context = context; + this.classLoader = new ClassLoaderImpl(); + } + + /** + * This class loader provides resource access to META-INF/services/... which is used by + * many frameworks. OSGi Import-Package and DynmaicImport-Package headers do not support + * split packages. Another option is to use Require-Bundle header. We can collect the list + * of bundles and add them as required bundles to a special gateway bundle. + */ + public class ClassLoaderImpl extends SecureClassLoader { + + public ClassLoaderImpl() { + super(OSGiServiceDiscoverer.class.getClassLoader()); + } + + /** + * Open a back-door to expose the META-INF/services resources + */ + @Override + protected URL findResource(String name) { + int index = name.lastIndexOf('/'); + if (index == -1) { + return null; + } + String path = name.substring(0, index); + if (path.startsWith("/")) { + path = path.substring(1); + } + + if (!path.startsWith("META-INF/services")) { + return null; + } + + for (Bundle bundle : context.getBundles()) { + URL url = bundle.getEntry(name); + if (url != null) { + return url; + } + } + + return null; + } + + /** + * Open a back-door to expose the META-INF/services resources + */ + @Override + protected Enumeration<URL> findResources(String name) throws IOException { + int index = name.lastIndexOf('/'); + if (index == -1) { + return null; + } + String path = name.substring(0, index); + String file = name.substring(index + 1); + if (path.startsWith("/")) { + path = path.substring(1); + } + + if (!path.startsWith("META-INF/services")) { + return null; + } + + Set<URL> urlSet = new HashSet<URL>(); + + for (Bundle bundle : context.getBundles()) { + Enumeration<URL> urls = bundle.findEntries(path, file, false); + if (urls != null) { + urlSet.addAll(Collections.list(urls)); + } + } + return Collections.enumeration(urlSet); + } + + } + + public static class ServiceDeclarationImpl implements ServiceDeclaration { + private Bundle bundle; + private URL url; + private String className; + private Class<?> javaClass; + private Map<String, String> attributes; + + public ServiceDeclarationImpl(Bundle bundle, URL url, String className, Map<String, String> attributes) { + super(); + this.bundle = bundle; + this.url = url; + this.className = className; + this.attributes = attributes; + } + + public Map<String, String> getAttributes() { + return attributes; + } + + public String getClassName() { + return className; + } + + public Class<?> loadClass() throws ClassNotFoundException { + if (className == null) { + return null; + } + if (javaClass == null) { + javaClass = loadClass(className); + } + return javaClass; + } + + public Class<?> loadClass(String className) throws ClassNotFoundException { + try { + return bundle.loadClass(className); + } catch (ClassNotFoundException e) { + logger.severe(e.getMessage() + ": " + OSGiServiceDiscoverer.toString(bundle)); + throw e; + } + } + + public URL getLocation() { + return url; + } + + public URL getResource(final String name) { + return AccessController.doPrivileged(new PrivilegedAction<URL>() { + public URL run() { + return bundle.getResource(name); + } + }); + } + + @Override + public String toString() { + StringBuffer sb = new StringBuffer(); + sb.append("Bundle: ").append(OSGiServiceDiscoverer.toString(bundle)); + sb.append(" Resource: ").append(url); + sb.append(" Attributes: ").append(attributes); + return sb.toString(); + } + + } + + public static String toString(Bundle b) { + StringBuffer sb = new StringBuffer(); + sb.append(b.getBundleId()).append(" ").append(b.getSymbolicName()); + int s = b.getState(); + if ((s & Bundle.UNINSTALLED) != 0) { + sb.append(" UNINSTALLED"); + } + if ((s & Bundle.INSTALLED) != 0) { + sb.append(" INSTALLED"); + } + if ((s & Bundle.RESOLVED) != 0) { + sb.append(" RESOLVED"); + } + if ((s & Bundle.STARTING) != 0) { + sb.append(" STARTING"); + } + if ((s & Bundle.STOPPING) != 0) { + sb.append(" STOPPING"); + } + if ((s & Bundle.ACTIVE) != 0) { + sb.append(" ACTIVE"); + } + return sb.toString(); + + } + + /** + * 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 + */ + protected static Map<String, String> parseServiceDeclaration(String declaration) { + Map<String, String> attributes = new HashMap<String, String>(); + 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; + } + + public BundleContext getBundleContext() { + return context; + } + + /** + * This class loader can be set as the thread context class loader for non-OSGi code + * @return + */ + public ClassLoader getContextClassLoader() { + return classLoader; + } + + @SuppressWarnings("unchecked") + public Set<ServiceDeclaration> discover(String serviceName, boolean firstOnly) { + boolean debug = logger.isLoggable(Level.FINE); + Set<ServiceDeclaration> descriptors = new HashSet<ServiceDeclaration>(); + + serviceName = "META-INF/services/" + serviceName; + + // int index = serviceName.lastIndexOf('/'); + // String path = serviceName.substring(0, index); + // String file = serviceName.substring(index + 1); + + // long start = System.currentTimeMillis(); + try { + for (Bundle bundle : context.getBundles()) { + // Enumeration<URL> urls = bundle.findEntries(path, file, false); // This is expensive + final URL url = bundle.getEntry(serviceName); + if (url == null) { + continue; + } + + if (debug) { + logger.fine("Reading service provider file: " + url.toExternalForm()); + } + try { + // Allow privileged access to open URL stream. Add FilePermission to added to security + // policy file. + InputStream is; + try { + is = AccessController.doPrivileged(new PrivilegedExceptionAction<InputStream>() { + public InputStream run() throws IOException { + return url.openStream(); + } + }); + } catch (PrivilegedActionException e) { + throw (IOException)e.getException(); + } + BufferedReader reader = null; + try { + reader = new BufferedReader(new InputStreamReader(is)); + int count = 0; + 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<String, String> attributes = parseServiceDeclaration(reg); + String className = attributes.get("class"); + if (className == null) { + // Add a unique class name to prevent equals() from returning true + className = "_class_" + count; + count++; + } + ServiceDeclarationImpl descriptor = + new ServiceDeclarationImpl(bundle, url, className, attributes); + descriptors.add(descriptor); + if (firstOnly) { + return descriptors; + } + } + } + } finally { + if (reader != null) { + try { + reader.close(); + } catch (IOException e) { + // Ignore + } + } + } + } catch (IOException e) { + logger.log(Level.SEVERE, e.getMessage(), e); + } + } + } finally { +// long end = System.currentTimeMillis(); +// if (true) { +// logger.info("Duration: " + (end - start) + " ms"); +// } + } + return descriptors; + + } + +} diff --git a/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoveryActivator.java b/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoveryActivator.java new file mode 100644 index 0000000000..208ef1a74f --- /dev/null +++ b/sandbox/event/modules/extensibility-osgi/src/main/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscoveryActivator.java @@ -0,0 +1,45 @@ +/* + * 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.osgi; + +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; +import org.osgi.framework.BundleActivator; +import org.osgi.framework.BundleContext; + +/** + * The Bundle Activator that creates the OSGi-based service discoverer + */ +public class OSGiServiceDiscoveryActivator implements BundleActivator { + private static BundleContext bundleContext; + + public void start(BundleContext context) throws Exception { + if (bundleContext == null) { + bundleContext = context; + OSGiServiceDiscoverer discoverer = new OSGiServiceDiscoverer(bundleContext); + ServiceDiscovery.getInstance().setServiceDiscoverer(discoverer); + } + } + + public void stop(BundleContext context) throws Exception { + bundleContext = null; + // ServiceDiscovery.setServiceDiscoverer(discoverer); + } + +} diff --git a/sandbox/event/modules/extensibility-osgi/src/test/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscovererTestCase.java b/sandbox/event/modules/extensibility-osgi/src/test/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscovererTestCase.java new file mode 100644 index 0000000000..aba7e62637 --- /dev/null +++ b/sandbox/event/modules/extensibility-osgi/src/test/java/org/apache/tuscany/sca/extensibility/osgi/OSGiServiceDiscovererTestCase.java @@ -0,0 +1,123 @@ +/* + * 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.osgi; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import junit.framework.Assert; + +import org.apache.felix.framework.Felix; +import org.apache.felix.framework.cache.BundleCache; +import org.apache.felix.framework.util.FelixConstants; +import org.apache.tuscany.sca.extensibility.ServiceDeclaration; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleActivator; +import org.osgi.framework.BundleContext; +import org.osgi.framework.Constants; + +/** + * + */ +public class OSGiServiceDiscovererTestCase { + private static Felix felix; + private static OSGiServiceDiscoverer discoverer; + private static Bundle testBundle; + + /** + * @throws java.lang.Exception + */ + @BeforeClass + public static void setUpBeforeClass() throws Exception { + // Create a configuration property map. + Map<String, String> configMap = new HashMap<String, String>(); + // Configure the Felix instance to be embedded. + configMap.put(FelixConstants.EMBEDDED_EXECUTION_PROP, "true"); + // Add core OSGi packages to be exported from the class path + // via the system bundle. + configMap.put(Constants.FRAMEWORK_SYSTEMPACKAGES, + "org.osgi.framework; version=1.3.0," + "org.osgi.service.packageadmin; version=1.2.0," + + "org.osgi.service.startlevel; version=1.0.0," + + "org.osgi.service.url; version=1.0.0"); + // Explicitly specify the directory to use for caching bundles. + configMap.put(BundleCache.CACHE_PROFILE_DIR_PROP, "target/.felix"); + List<BundleActivator> list = new ArrayList<BundleActivator>(); + + // Now create an instance of the framework with + // our configuration properties and activator. + felix = new Felix(configMap, list); + + // Now start Felix instance. + felix.start(); + BundleContext context = felix.getBundleContext(); + InputStream is = OSGiServiceDiscovererTestCase.class.getResourceAsStream("/test-bundle.jar"); + testBundle = context.installBundle("test-bundle", is); + is.close(); + discoverer = new OSGiServiceDiscoverer(context); + } + + /** + * @throws java.lang.Exception + */ + @AfterClass + public static void tearDownAfterClass() throws Exception { + if (felix != null) { + // Uninstall the bundle to clean up the cache + testBundle.uninstall(); + felix.stop(); + } + } + + @Test + public void testDiscovery() { + Set<ServiceDeclaration> descriptors = + discoverer.discover("test.TestService", false); + Assert.assertEquals(1, descriptors.size()); + descriptors = discoverer.discover("notthere", false); + Assert.assertEquals(0, descriptors.size()); + } + + @Test + public void testDiscoveryFirst() { + Set<ServiceDeclaration> descriptors = + discoverer.discover("test.TestService", true); + Assert.assertEquals(1, descriptors.size()); + descriptors = discoverer.discover("notthere", true); + Assert.assertEquals(0, descriptors.size()); + } + + @Test + public void testClassLoader () throws IOException { + Enumeration<URL> resources = discoverer.getContextClassLoader().getResources("META-INF/services/test.TestService"); + List<URL> list = Collections.list(resources); + Assert.assertEquals(1, list.size()); + } +} diff --git a/sandbox/event/modules/extensibility-osgi/src/test/resources/test-bundle.jar b/sandbox/event/modules/extensibility-osgi/src/test/resources/test-bundle.jar Binary files differnew file mode 100644 index 0000000000..afee051f61 --- /dev/null +++ b/sandbox/event/modules/extensibility-osgi/src/test/resources/test-bundle.jar |