This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.commons.classloader-0.9.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-classloader.git
commit 046ba4fd01b89045e0b0c13bcdf2e87f8073b3e7 Author: Carsten Ziegeler <[email protected]> AuthorDate: Mon Jul 6 19:53:28 2009 +0000 SLING-1007 : Initial work of a dynamic class loader loading classes through package admin. In addition dynamic class loader providers can be registered. git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/commons/classloader@791586 13f79535-47bb-0310-9956-ffa450edef68 --- LICENSE | 202 +++++++++++++++++++++ NOTICE | 9 + pom.xml | 98 ++++++++++ .../classloader/DynamicClassLoaderManager.java | 34 ++++ .../classloader/DynamicClassLoaderProvider.java | 35 ++++ .../sling/commons/classloader/impl/Activator.java | 80 ++++++++ .../classloader/impl/ClassLoaderFacade.java | 96 ++++++++++ .../impl/DynamicClassLoaderManagerImpl.java | 136 ++++++++++++++ .../classloader/impl/PackageAdminClassLoader.java | 93 ++++++++++ src/main/resources/META-INF/LICENSE | 202 +++++++++++++++++++++ src/main/resources/META-INF/NOTICE | 9 + 11 files changed, 994 insertions(+) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..404f9a9 --- /dev/null +++ b/NOTICE @@ -0,0 +1,9 @@ +Apache Sling Commons Class Loader +Copyright 2009 The Apache Software Foundation + +Apache Sling is based on source code originally developed +by Day Software (http://www.day.com/). + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..87f1013 --- /dev/null +++ b/pom.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + 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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.sling</groupId> + <artifactId>sling</artifactId> + <version>6</version> + <relativePath>../../../parent/pom.xml</relativePath> + </parent> + + <artifactId>org.apache.sling.commons.classloader</artifactId> + <packaging>bundle</packaging> + <version>0.9.0-SNAPSHOT</version> + + <name>Apache Sling Dynamic Class Loader Support</name> + <description> + This bundle provides support for dynamic class loading used for example by the scripting engines. + </description> + + <scm> + <connection>scm:svn:http://svn.apache.org/repos/asf/sling/trunk/bundles/commons/classloader</connection> + <developerConnection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/bundles/commons/classloader</developerConnection> + <url>http://svn.apache.org/viewvc/sling/trunk/bundles/commons/classloader</url> + </scm> + + <build> + <plugins> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-scr-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <extensions>true</extensions> + <configuration> + <instructions> + <Bundle-Activator> + org.apache.sling.commons.classloader.impl.Activator + </Bundle-Activator> + <Export-Package> + org.apache.sling.commons.classloader;version=${pom.version} + </Export-Package> + <Private-Package> + org.apache.sling.commons.classloader.impl + </Private-Package> + </instructions> + </configuration> + </plugin> + </plugins> + </build> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <configuration> + <excludePackageNames> + org.apache.sling.commons.classloader.impl + </excludePackageNames> + </configuration> + </plugin> + </plugins> + </reporting> + <dependencies> + <dependency> + <groupId>org.apache.felix</groupId> + <artifactId>org.osgi.core</artifactId> + </dependency> + <dependency> + <groupId>org.apache.felix</groupId> + <artifactId>org.osgi.compendium</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + </dependency> + </dependencies> +</project> diff --git a/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderManager.java b/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderManager.java new file mode 100644 index 0000000..ff23e78 --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderManager.java @@ -0,0 +1,34 @@ +/* + * 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.sling.commons.classloader; + +/** + * The dynamic class loader manager is a central + * service managing all dynamic class loaders. + * It provides a class loader that can be used by + * bundles requiring access to all publically available + * classes. + */ +public interface DynamicClassLoaderManager { + + /** + * The dynamic class loader. + */ + ClassLoader getDynamicClassLoader(); +} diff --git a/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderProvider.java b/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderProvider.java new file mode 100644 index 0000000..04eaf8e --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/DynamicClassLoaderProvider.java @@ -0,0 +1,35 @@ +/* + * 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.sling.commons.classloader; + +/** + * A dynamic class loader provider allows to provide + * class loaders that will be used by the dynamic + * class loading mechanism. For instance a JCR class loader + * provider could provide some class loader loading classes + * from a content repository etc. + */ +public interface DynamicClassLoaderProvider { + + /** + * Return the class loader used for dynamic class loading. + * @return The class loader. + */ + ClassLoader getClassLoader(); +} diff --git a/src/main/java/org/apache/sling/commons/classloader/impl/Activator.java b/src/main/java/org/apache/sling/commons/classloader/impl/Activator.java new file mode 100644 index 0000000..a58d83e --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/impl/Activator.java @@ -0,0 +1,80 @@ +/* + * 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.sling.commons.classloader.impl; + +import java.util.Hashtable; + +import org.osgi.framework.BundleActivator; +import org.osgi.framework.BundleContext; +import org.osgi.framework.Constants; +import org.osgi.framework.ServiceRegistration; +import org.osgi.service.packageadmin.PackageAdmin; +import org.osgi.util.tracker.ServiceTracker; + +/** + * This activator registers the dynamic class loader manager. + */ +public class Activator implements BundleActivator { + + /** Package admin service name */ + private static String PACKAGE_ADMIN_NAME = PackageAdmin.class.getName(); + + /** A service tracker for the package admin. */ + private ServiceTracker packageAdminTracker; + + /** The service registration for the dynamic class loader manager. */ + private ServiceRegistration serviceReg; + + /** The dynamic class loader service. */ + private DynamicClassLoaderManagerImpl service; + + /** + * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext) + */ + public void start(BundleContext context) throws Exception { + this.packageAdminTracker = new ServiceTracker(context, PACKAGE_ADMIN_NAME, null); + this.packageAdminTracker.open(); + + // register service + final Hashtable<String, String> props = new Hashtable<String, String>(); + props.put(Constants.SERVICE_DESCRIPTION, "Apache Sling Dynamic Class Loader Service"); + props.put(Constants.SERVICE_VENDOR, "The Apache Software Foundation"); + this.service = new DynamicClassLoaderManagerImpl(context, + (PackageAdmin)this.packageAdminTracker.getService()); + this.serviceReg = context.registerService(new String[] {DynamicClassLoaderManagerImpl.class.getName()}, service, props); + } + + /** + * @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext) + */ + public void stop(BundleContext context) throws Exception { + if ( this.serviceReg != null ) { + this.serviceReg.unregister(); + this.serviceReg = null; + } + if ( this.service != null ) { + this.service.deactivate(); + this.service = null; + } + if ( this.packageAdminTracker != null ) { + this.packageAdminTracker.close(); + this.packageAdminTracker = null; + } + } +} diff --git a/src/main/java/org/apache/sling/commons/classloader/impl/ClassLoaderFacade.java b/src/main/java/org/apache/sling/commons/classloader/impl/ClassLoaderFacade.java new file mode 100644 index 0000000..1ef22a4 --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/impl/ClassLoaderFacade.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.sling.commons.classloader.impl; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.Enumeration; + + +/** + * The <code>ClassLoaderFacade</code> is a facade + * for the dynamic class loading. + */ +public class ClassLoaderFacade extends ClassLoader { + + private final DynamicClassLoaderManagerImpl manager; + + public ClassLoaderFacade(final DynamicClassLoaderManagerImpl manager) { + this.manager = manager; + } + + /** + * @see java.lang.ClassLoader#getResource(java.lang.String) + */ + public URL getResource(String name) { + final ClassLoader[] loaders = manager.getDynamicClassLoaders(); + for(final ClassLoader cl : loaders) { + final URL u = cl.getResource(name); + if ( u != null ) { + return u; + } + } + return null; + } + + /** + * @see java.lang.ClassLoader#getResourceAsStream(java.lang.String) + */ + public InputStream getResourceAsStream(String name) { + final ClassLoader[] loaders = manager.getDynamicClassLoaders(); + for(final ClassLoader cl : loaders) { + final InputStream i = cl.getResourceAsStream(name); + if ( i != null ) { + return i; + } + } + return null; + } + + /** + * @see java.lang.ClassLoader#getResources(java.lang.String) + */ + public Enumeration<URL> getResources(String name) throws IOException { + final ClassLoader[] loaders = manager.getDynamicClassLoaders(); + for(final ClassLoader cl : loaders) { + final Enumeration<URL> e = cl.getResources(name); + if ( e != null && e.hasMoreElements() ) { + return e; + } + } + return null; + } + + /** + * @see java.lang.ClassLoader#loadClass(java.lang.String) + */ + public Class<?> loadClass(String name) throws ClassNotFoundException { + final ClassLoader[] loaders = manager.getDynamicClassLoaders(); + for(final ClassLoader cl : loaders) { + try { + final Class<?> c = cl.loadClass(name); + return c; + } catch (Exception cnfe) { + // we just ignore this and try the next class loader + } + } + throw new ClassNotFoundException("Class not found: " + name); + } +} diff --git a/src/main/java/org/apache/sling/commons/classloader/impl/DynamicClassLoaderManagerImpl.java b/src/main/java/org/apache/sling/commons/classloader/impl/DynamicClassLoaderManagerImpl.java new file mode 100644 index 0000000..5257103 --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/impl/DynamicClassLoaderManagerImpl.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.sling.commons.classloader.impl; + +import java.util.Arrays; +import java.util.Comparator; + +import org.apache.sling.commons.classloader.DynamicClassLoaderManager; +import org.apache.sling.commons.classloader.DynamicClassLoaderProvider; +import org.osgi.framework.BundleContext; +import org.osgi.framework.ServiceReference; +import org.osgi.service.packageadmin.PackageAdmin; +import org.osgi.util.tracker.ServiceTracker; +import org.osgi.util.tracker.ServiceTrackerCustomizer; + +/** + * This is the default implementation of the dynamic class loader + * manager. + */ +public class DynamicClassLoaderManagerImpl + extends ServiceTracker + implements DynamicClassLoaderManager, ServiceTrackerCustomizer { + + /** The package admin class loader. */ + private final PackageAdminClassLoader pckAdminCL; + + /** The dynamic class loader. */ + private final ClassLoaderFacade facade; + + /** The bundle context. */ + private final BundleContext context; + + private ClassLoader[] cache; + + private boolean updateCache = false; + + /** + * Create a new service instance + * @param ctx The bundle context. + * @param pckAdmin The package admin. + */ + public DynamicClassLoaderManagerImpl(final BundleContext ctx, + final PackageAdmin pckAdmin) { + super(ctx, DynamicClassLoaderProvider.class.getName(), null); + this.context = ctx; + this.pckAdminCL = new PackageAdminClassLoader(pckAdmin, this.getClass().getClassLoader()); + this.cache = new ClassLoader[] {this.pckAdminCL}; + this.open(); + this.facade = new ClassLoaderFacade(this); + } + + public Object addingService(ServiceReference reference) { + this.updateCache = true; + return this.context.getService(reference); + } + + public void modifiedService(ServiceReference reference, Object service) { + // as the ranking property has changed we have to update the cache + this.updateCache = true; + } + + public void removedService(ServiceReference reference, Object service) { + this.context.ungetService(reference); + this.updateCache = true; + } + + private synchronized void updateCache() { + if ( this.updateCache ) { + final ServiceReference[] refs = this.getServiceReferences(); + final ClassLoader[] loaders = new ClassLoader[1 + refs.length]; + Arrays.sort(refs, ServiceReferenceComparator.INSTANCE); + loaders[0] = this.pckAdminCL; + int index = 1; + for(final ServiceReference ref : refs) { + loaders[index] = (ClassLoader) this.getService(ref); + index++; + } + // and now use new array + this.cache = loaders; + this.updateCache = false; + } + } + + /** + * Deactivate this service. + */ + public void deactivate() { + this.close(); + } + + + /** + * @see org.apache.sling.commons.classloader.DynamicClassLoaderManager#getDynamicClassLoader() + */ + public ClassLoader getDynamicClassLoader() { + return this.facade; + } + + /** + * This list contains the current list of class loaders. The first class loader + * is always the package admin class loader, therefore this list is never null + * and has always a size greater than zero. + * @return The list of class loaders. + */ + public ClassLoader[] getDynamicClassLoaders() { + if ( this.updateCache ) { + updateCache(); + } + return this.cache; + } + + /** + * Comparator for service references. + */ + protected static final class ServiceReferenceComparator implements Comparator<ServiceReference> { + public static ServiceReferenceComparator INSTANCE = new ServiceReferenceComparator(); + + public int compare(ServiceReference o1, ServiceReference o2) { + return o1.compareTo(o2); + } + } +} diff --git a/src/main/java/org/apache/sling/commons/classloader/impl/PackageAdminClassLoader.java b/src/main/java/org/apache/sling/commons/classloader/impl/PackageAdminClassLoader.java new file mode 100644 index 0000000..9cd07a5 --- /dev/null +++ b/src/main/java/org/apache/sling/commons/classloader/impl/PackageAdminClassLoader.java @@ -0,0 +1,93 @@ +/* + * 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.sling.commons.classloader.impl; + +import java.io.IOException; +import java.net.URL; +import java.util.Enumeration; + +import org.osgi.framework.Bundle; +import org.osgi.service.packageadmin.ExportedPackage; +import org.osgi.service.packageadmin.PackageAdmin; + +/** + * The <code>PackageAdminClassLoader</code> + */ +class PackageAdminClassLoader extends ClassLoader { + + private final PackageAdmin packageAdmin; + + public PackageAdminClassLoader(final PackageAdmin pckAdmin, final ClassLoader parent) { + super(parent); + this.packageAdmin = pckAdmin; + } + + private Bundle findBundleForClassOrResource(final String name) { + final int lastDot = name.lastIndexOf('.'); + final String pckName = (lastDot == -1 ? "" : name.substring(0, lastDot)); + + final ExportedPackage exportedPackage = this.packageAdmin.getExportedPackage(pckName); + return (exportedPackage == null ? null : exportedPackage.getExportingBundle()); + } + + /** + * @see java.lang.ClassLoader#getResources(java.lang.String) + */ + @SuppressWarnings("unchecked") + public Enumeration<URL> getResources(String name) throws IOException { + final Bundle bundle = this.findBundleForClassOrResource(name); + if ( bundle == null ) { + return super.getResources(name); + } + return bundle.getResources(name); + } + + /** + * @see java.lang.ClassLoader#findResource(java.lang.String) + */ + public URL findResource(String name) { + final Bundle bundle = this.findBundleForClassOrResource(name); + if ( bundle == null ) { + return super.findResource(name); + } + return bundle.getResource(name); + } + + /** + * @see java.lang.ClassLoader#findClass(java.lang.String) + */ + public Class<?> findClass(String name) throws ClassNotFoundException { + final Bundle bundle = this.findBundleForClassOrResource(name); + if ( bundle == null ) { + return super.findClass(name); + } + return bundle.loadClass(name); + } + + /** + * @see java.lang.ClassLoader#loadClass(java.lang.String, boolean) + */ + protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException { + final Bundle bundle = this.findBundleForClassOrResource(name); + if ( bundle == null ) { + return super.loadClass(name, resolve); + } + return bundle.loadClass(name); + } +} diff --git a/src/main/resources/META-INF/LICENSE b/src/main/resources/META-INF/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/src/main/resources/META-INF/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/src/main/resources/META-INF/NOTICE b/src/main/resources/META-INF/NOTICE new file mode 100644 index 0000000..404f9a9 --- /dev/null +++ b/src/main/resources/META-INF/NOTICE @@ -0,0 +1,9 @@ +Apache Sling Commons Class Loader +Copyright 2009 The Apache Software Foundation + +Apache Sling is based on source code originally developed +by Day Software (http://www.day.com/). + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
