diff options
Diffstat (limited to 'sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src')
6 files changed, 675 insertions, 0 deletions
diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoverer.java b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoverer.java new file mode 100644 index 0000000000..5ab5a66077 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoverer.java @@ -0,0 +1,281 @@ +/* + * 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.equinox; + +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.util.Arrays; +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; + +/** + * A ServiceDiscoverer that find META-INF/services/... in installed bundles + * + * @version $Rev$ $Date$ + */ +public class EquinoxServiceDiscoverer implements ServiceDiscoverer { + private static final Logger logger = Logger.getLogger(EquinoxServiceDiscoverer.class.getName()); + + private BundleContext context; + + public EquinoxServiceDiscoverer(BundleContext context) { + this.context = context; + } + + 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 { + return bundle.loadClass(className); + } + + public URL getLocation() { + return url; + } + + public URL getResource(final String name) { + return AccessController.doPrivileged(new PrivilegedAction<URL>() { + public URL run() { + return bundle.getResource(name); + } + }); + } + + public String toString() { + StringBuffer sb = new StringBuffer(); + sb.append("Bundle: ").append(EquinoxServiceDiscoverer.toString(bundle)); + sb.append(" Resource: ").append(url); + sb.append(" Attributes: ").append(attributes); + return sb.toString(); + } + + } + + public static void init() { + // Empty static method to trigger the activation of this bundle + } + + private 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 + */ + private 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 Set<ServiceDeclaration> discover(String serviceName, boolean firstOnly) { + boolean debug = logger.isLoggable(Level.FINE); + Set<ServiceDeclaration> descriptors = new HashSet<ServiceDeclaration>(); + + serviceName = "META-INF/services/" + serviceName; + + for (Bundle bundle : context.getBundles()) { + if (bundle.getBundleId() == 0) { + // Skip system bundle as it has access to the application classloader + continue; + } + Enumeration<URL> urls = null; + try { + // Use getResources to find resources on the classpath of the bundle + // Please note if there is an DynamicImport-Package=*, and another bundle + // exports the resource package, there is a possiblity that it doesn't + // find the containing entry + urls = bundle.getResources(serviceName); + if (urls == null) { + URL entry = bundle.getEntry(serviceName); + if (entry != null) { + urls = Collections.enumeration(Arrays.asList(entry)); + } + } + } catch (IOException e) { + logger.log(Level.SEVERE, e.getMessage(), e); + } + if (urls == null) { + continue; + } + while (urls.hasMoreElements()) { + final URL url = urls.nextElement(); + + 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); + } + } + } + return descriptors; + } + +} diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoveryActivator.java b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoveryActivator.java new file mode 100644 index 0000000000..fa137daa16 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/main/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscoveryActivator.java @@ -0,0 +1,46 @@ +/* + * 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.equinox; + +import java.util.logging.Logger; + +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; +import org.osgi.framework.BundleActivator; +import org.osgi.framework.BundleContext; + +/** + * The Bundle Activator that creates the Equinox-based service discoverer + * + * @version $Rev$ $Date$ + */ +public class EquinoxServiceDiscoveryActivator implements BundleActivator { + private static Logger logger = Logger.getLogger(EquinoxServiceDiscoveryActivator.class.getName()); + + public void start(BundleContext context) throws Exception { + logger.info("Installing service discovery"); + EquinoxServiceDiscoverer discoverer = new EquinoxServiceDiscoverer(context); + ServiceDiscovery.getInstance().setServiceDiscoverer(discoverer); + logger.info("Installed service discovery"); + } + + public void stop(BundleContext context) throws Exception { + } + +} diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxHostTestCase.java b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxHostTestCase.java new file mode 100644 index 0000000000..7602b02488 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxHostTestCase.java @@ -0,0 +1,96 @@ +/* + * 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.equinox; + +import java.util.Dictionary; +import java.util.Enumeration; + +import junit.framework.Assert; + +import org.junit.Test; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleContext; + +/** + * Test start/stop the Equinox runtime. + * + * @version $Rev: $ $Date: $ + */ +public class EquinoxHostTestCase { + @Test + public void testStartThenStop() { + TestEquinoxHost host = new TestEquinoxHost(); + BundleContext context = host.start(); + Assert.assertNotNull(context); + for (Bundle b : context.getBundles()) { + System.out.println(toString(b, false)); + } + host.stop(); + } + + @Test + public void testStartTwice() { + TestEquinoxHost host = new TestEquinoxHost(); + host.start(); + try { + host.start(); + Assert.fail(); + } catch (IllegalStateException e) { + Assert.assertTrue(IllegalStateException.class.isInstance(e.getCause())); + } finally { + host.stop(); + } + } + + public static String toString(Bundle b, boolean verbose) { + 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"); + } + + sb.append(" ").append(b.getLocation()); + if (verbose) { + Dictionary<Object, Object> dict = b.getHeaders(); + Enumeration<Object> keys = dict.keys(); + while (keys.hasMoreElements()) { + Object key = keys.nextElement(); + sb.append(" ").append(key).append("=").append(dict.get(key)); + } + } + return sb.toString(); + } +} diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscovererTestCase.java b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscovererTestCase.java new file mode 100644 index 0000000000..3126365748 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/EquinoxServiceDiscovererTestCase.java @@ -0,0 +1,152 @@ +/* + * 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.equinox; + +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.InputStream; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.List; +import java.util.Set; +import java.util.jar.JarInputStream; +import java.util.jar.Manifest; + +import junit.framework.Assert; + +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.BundleContext; + +/** + * Test the Equinox service discoverer. + * + * @version $Rev$ $Date$ + */ +public class EquinoxServiceDiscovererTestCase { + private static EquinoxServiceDiscoverer discoverer; + private static Bundle testBundle; + private static TestEquinoxHost host; + + private static String getState(Bundle b) { + StringBuffer sb = new StringBuffer(); + 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(); + + } + + /** + * @throws java.lang.Exception + */ + @BeforeClass + public static void setUpBeforeClass() throws Exception { + host = new TestEquinoxHost(); + BundleContext context = host.start(); + + InputStream is = EquinoxServiceDiscovererTestCase.class.getResourceAsStream("/test-bundle.jar"); + testBundle = context.installBundle("test-bundle", is); + is.close(); + discoverer = new EquinoxServiceDiscoverer(context); + File dep = new File("target/bundles"); + List<Bundle> bundles = new ArrayList<Bundle>(); + for (File f : dep.listFiles()) { + BufferedInputStream bis = new BufferedInputStream(new FileInputStream(f)); + JarInputStream jis = new JarInputStream(bis); + Manifest manifest = jis.getManifest(); + if (manifest == null || manifest.getMainAttributes().getValue("Bundle-Name") == null) { + bis.close(); + continue; + } + bis.close(); + bis = new BufferedInputStream(new FileInputStream(f)); + Bundle b = context.installBundle(f.getName(), bis); + System.out.println("Installed "+b.getSymbolicName() + " [" + getState(b) + "]"); + bundles.add(b); + bis.close(); + } + for (Bundle b : bundles) { + b.start(); + System.out.println("Started "+b.getSymbolicName() + " [" + getState(b) + "]"); + // Get the Platform.getExtensionRegistry() + if ("org.eclipse.core.runtime".equals(b.getSymbolicName())) { + // The Platform class loaded by the bundle is different that the one + // on the classpath + Class<?> cls = b.loadClass("org.eclipse.core.runtime.Platform"); + Method m = cls.getMethod("getExtensionRegistry"); + Object reg = m.invoke(cls); + System.out.println(reg); + } + } + } + + /** + * @throws java.lang.Exception + */ + @AfterClass + public static void tearDownAfterClass() throws Exception { + if (testBundle != null) { + // Uninstall the bundle to clean up the cache + testBundle.uninstall(); + } + host.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()); + } + + +} diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/TestEquinoxHost.java b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/TestEquinoxHost.java new file mode 100644 index 0000000000..e000faa447 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/java/org/apache/tuscany/sca/extensibility/equinox/TestEquinoxHost.java @@ -0,0 +1,100 @@ +/* + * 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.equinox; + +import java.io.File; +import java.util.HashMap; +import java.util.Map; + +import org.eclipse.core.runtime.adaptor.EclipseStarter; +import org.eclipse.core.runtime.adaptor.LocationManager; +import org.osgi.framework.BundleContext; + +/** + * A test host that starts/stops Equinox. + * + * @version $Rev: $ $Date: $ + */ +public class TestEquinoxHost { + + private final static String 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, " + + "org.osgi.util.tracker; version=1.3.2, " + + "javax.xml, " + + "javax.xml.datatype, " + + "javax.xml.namespace, " + + "javax.xml.parsers, " + + "javax.xml.transform, " + + "javax.xml.transform.dom, " + + "javax.xml.transform.sax, " + + "javax.xml.transform.stream, " + + "javax.xml.validation, " + + "javax.xml.xpath, " + // Force the classes to be imported from the system bundle + + "javax.xml.stream, " + + "javax.xml.stream.util, " + + "javax.sql," + + "org.w3c.dom, " + + "org.xml.sax, " + + "org.xml.sax.ext, " + + "org.xml.sax.helpers, " + + "javax.security.auth, " + + "javax.security.cert, " + + "javax.security.auth.login, " + + "javax.security.auth.callback, " + + "javax.naming, " + + "javax.naming.spi, " + + "javax.naming.directory, " + + "javax.management, " + + "javax.imageio, " + + "sun.misc, " + + "javax.net, " + + "javax.net.ssl, " + + "javax.crypto, " + + "javax.rmi, " + + "javax.transaction, " + + "javax.transaction.xa"; + + public BundleContext start() { + try { + Map<Object, Object> props = new HashMap<Object, Object>(); + props.put("org.osgi.framework.system.packages", systemPackages); + props.put(EclipseStarter.PROP_CLEAN, "true"); + props.put(LocationManager.PROP_INSTANCE_AREA, new File("target/workspace").toURI().toString()); + props.put(LocationManager.PROP_INSTALL_AREA, new File("target/eclipse").toURI().toString()); + EclipseStarter.setInitialProperties(props); + BundleContext context = EclipseStarter.startup(new String[]{}, null); + return context; + } catch (Exception e) { + throw new IllegalStateException(e); + } + } + + public void stop() { + try { + EclipseStarter.shutdown(); + } catch (Exception e) { + throw new IllegalStateException(e); + } + } + +} diff --git a/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/resources/test-bundle.jar b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/resources/test-bundle.jar Binary files differnew file mode 100644 index 0000000000..afee051f61 --- /dev/null +++ b/sca-java-1.x/tags/1.6-TUSCANY-3909/extensibility-equinox/src/test/resources/test-bundle.jar |