TUSCANY-2972 - Sample code for fixing up classloaders for JEE archives. No where near done yet but allows us to experiment and explore the problems.

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

8 files changed, 397 insertions, 1 deletions

diff --git a/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoader.java b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoader.java
new file mode 100644
index 0000000000..bc009c50d7
--- /dev/null
+++ b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoader.java
@@ -0,0 +1,330 @@
+/*
+ * 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.contribution.jee.impl;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.HashSet;
+import java.util.List;
+
+import org.apache.tuscany.sca.contribution.Artifact;
+import org.apache.tuscany.sca.contribution.Contribution;
+import org.apache.tuscany.sca.contribution.Export;
+import org.apache.tuscany.sca.contribution.Import;
+import org.apache.tuscany.sca.contribution.java.JavaImport;
+import org.apache.tuscany.sca.contribution.jee.EjbModuleInfo;
+import org.apache.tuscany.sca.contribution.jee.JavaEEApplicationInfo;
+import org.apache.tuscany.sca.contribution.jee.WebModuleInfo;
+
+
+public class JEEClassLoader extends URLClassLoader {
+    
+    private Contribution contribution;
+    private List<WebModuleInfo> webModules = new ArrayList<WebModuleInfo>();
+    private List<EjbModuleInfo> ejbModules = new ArrayList<EjbModuleInfo>();
+    
+    /**
+     * Constructor for contribution ClassLoader 
+     * 
+     * @param contribution
+     * @param parent
+     * @throws MalformedURLException
+     */
+    public JEEClassLoader(Contribution contribution, final ClassLoader parent) {
+        super(new URL[0], parent);
+        
+        this.contribution = contribution;
+        
+        // get the classloaders for any JEE archives references by the contribution
+        // TODO extend to case where JEE archive is outside the contribution
+        for (Artifact artifact : contribution.getArtifacts()){
+            if (artifact.getModel() instanceof WebModuleInfo){
+                WebModuleInfo webModuleInfo = (WebModuleInfo)artifact.getModel();
+                webModules.add(webModuleInfo);
+            } else if (artifact.getModel() instanceof EjbModuleInfo){
+                EjbModuleInfo ejbModuleInfo = (EjbModuleInfo)artifact.getModel();
+                ejbModules.add(ejbModuleInfo);
+            } else if (artifact.getModel() instanceof JavaEEApplicationInfo){
+                JavaEEApplicationInfo jeeAppInfo = (JavaEEApplicationInfo)artifact.getModel();
+                webModules.addAll(jeeAppInfo.getWebModuleInfos().values());
+                ejbModules.addAll(jeeAppInfo.getEjbModuleInfos().values());
+            }
+        }
+             
+    }
+    
+    /* (non-Javadoc)
+     * @see java.net.URLClassLoader#findClass(java.lang.String)
+     * 
+     * Search path for class:
+     *     This contribution
+     *     Imported contributions
+     */
+    @Override   
+    protected Class<?> findClass(String className) throws ClassNotFoundException {
+               
+        Class<?> clazz = null;
+        ClassNotFoundException cne = null;
+        
+        // ask each of the JEE archive classloaders in turn
+        // TODO This is a bad thing as two archives may have the same class
+        //       but don't know how to avoid this
+        for (WebModuleInfo webModuleInfo : webModules){
+            try {
+                clazz = webModuleInfo.getModuleClassloader().loadClass(className);
+            } catch (ClassNotFoundException e) {
+                cne = e;
+            }
+            
+            if (clazz != null){
+                break;
+            }
+        }
+        
+        // We would expect the webapp classloaders to have an ejb classloader as parent
+        // but we have to go through the ebj module classloaders here just in case
+        // there are no webapps
+        for (EjbModuleInfo ejbModuleInfo : ejbModules){
+            try {
+                clazz = ejbModuleInfo.getModuleClassloader().loadClass(className);
+            } catch (ClassNotFoundException e) {
+                cne = e;
+            }
+            
+            if (clazz != null){
+                break;
+            }
+        }        
+        
+        if (clazz == null){
+            throw cne;
+        }
+             
+        return clazz;
+    }
+
+    
+    /* (non-Javadoc)
+     * @see java.lang.ClassLoader#loadClass(java.lang.String, boolean)
+     * 
+     * Search path for class:
+     *     Parent ClassLoader
+     *     This contribution
+     *     Imported contributions
+     *     
+     */
+    @Override
+    protected synchronized Class<?> loadClass(String className, boolean resolveClass) 
+        throws ClassNotFoundException {
+       
+        Class<?> clazz = null;
+        try {
+            
+            if (this.getParent() != null)
+                clazz = this.getParent().loadClass(className);
+            
+        } catch (ClassNotFoundException e) {
+        }
+
+        if (clazz == null)
+            clazz = findClass(className);
+
+
+        if (resolveClass)
+            this.resolveClass(clazz);
+        return clazz;
+        
+    }
+
+
+   
+    /*
+     * (non-Javadoc)
+     * 
+     * @see java.net.URLClassLoader#findResource(java.lang.String)
+     */
+    @Override
+    public URL findResource(String name) {
+        
+        URL url = null;
+/*        
+        URL url = findResourceFromContribution(name);
+        
+        if (url == null) {
+            for (Import import_ : this.contribution.getImports()) {
+                if (resourceNameMatchesImport(name, import_)) {
+                    // Delegate the resolution to the imported contribution
+                    for (Contribution exportingContribution : ((JavaImportModelResolver)import_.getModelResolver()).getExportContributions()) {
+                                
+                        ClassLoader exportClassLoader = getExportClassLoader(exportingContribution);
+                        if (exportClassLoader instanceof JEEClassLoader) {
+
+                            for (Export export : exportingContribution.getExports()) {
+                                if (import_.match(export)) {
+                                    url = ((JEEClassLoader)exportClassLoader).findResourceFromContribution(name);
+                                    if (url != null) break;
+                                }
+                            }
+                            if (url != null)  break;
+                        }
+                    }
+                    if (url != null) break;
+                }
+            }
+
+        }
+*/        
+        return url;
+    }
+
+
+    /* (non-Javadoc)
+     * @see java.net.URLClassLoader#findResources(java.lang.String)
+     */
+    @Override
+    public Enumeration<URL> findResources(String name) throws IOException {       
+        return Collections.enumeration(findResourceSet(name));
+    }
+    
+    /* (non-Javadoc)
+     * @see java.lang.ClassLoader#getResource(java.lang.String)
+     * 
+     * Find a resource. 
+     * Search path for resource:
+     *     Parent ClassLoader
+     *     This contribution
+     *     Imported contributions
+     */
+    @Override
+    public URL getResource(String resName) {
+ 
+        URL resource  = null;
+        
+        if (this.getParent() != null) {
+            resource  = this.getParent().getResource(resName);
+        }        
+        if (resource == null)
+            resource  = findResource(resName);
+        
+        return resource;
+    }
+
+
+    
+    /* (non-Javadoc)
+     * @see java.lang.ClassLoader#getResources(java.lang.String)
+     * 
+     * Return list of resources from this contribution, resources
+     * imported through imported contributions and resources from parent 
+     * ClassLoader.
+     */
+    @Override
+    public Enumeration<URL> getResources(String resName) throws IOException {
+       
+        HashSet<URL> resourceSet = findResourceSet(resName);
+        addEnumerationToCollection(resourceSet, super.getResources(resName));
+        
+        return Collections.enumeration(resourceSet);
+    }
+    
+
+    /*
+     * Find set of resources
+     */
+    private HashSet<URL> findResourceSet(String name) throws IOException {
+        
+        HashSet<URL> resources = new HashSet<URL>();
+
+/*
+        addEnumerationToCollection(resources, super.findResources(name));
+        
+        for (Import import_ : this.contribution.getImports()) {
+            if (!(import_ instanceof JavaImport)) {
+                continue;
+            }
+            if (resourceNameMatchesImport(name, import_)) {
+                // Delegate the resolution to the imported contribution
+                for (Contribution exportingContribution : ((JavaImportModelResolver)import_.getModelResolver()).getExportContributions()) {
+                                
+                    ClassLoader exportClassLoader = getExportClassLoader(exportingContribution);
+                    if (exportClassLoader instanceof JEEClassLoader) {
+
+                        for (Export export : exportingContribution.getExports()) {
+                            if (import_.match(export)) {
+                                addEnumerationToCollection(resources,
+                                        ((JEEClassLoader)exportClassLoader).findResources(name));
+                            }
+                        }
+                    }
+                }
+            }
+         }
+*/         
+
+        return resources;
+    }
+
+
+    /*
+     * Find class from contribution. If class has already been loaded, return loaded class.
+     */
+    private Class<?> findClassFromContribution(String className) throws ClassNotFoundException {
+        
+        Class<?> clazz = findLoadedClass(className);
+        if (clazz == null)
+            clazz =  super.findClass(className);
+        return clazz;
+       
+    }
+    
+    /*
+     * Find resource from contribution.
+     */
+    private URL findResourceFromContribution(String name) {
+        
+        return super.findResource(name);
+    }
+    
+    
+    /*
+     * Add an enumeration to a Collection
+     */
+    private <T extends Object> void addEnumerationToCollection(Collection<T> collection, Enumeration<T> enumeration) {
+        
+        while (enumeration.hasMoreElements())
+            collection.add(enumeration.nextElement());
+    }
+    
+    
+    @Override
+    public String toString() {
+        return "SCA JEE ClassLoader, parent ClassLoader: " + getParent();
+    }
+    
+    
+}
diff --git a/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoaderProvider.java b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoaderProvider.java
new file mode 100644
index 0000000000..73745fccef
--- /dev/null
+++ b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JEEClassLoaderProvider.java
@@ -0,0 +1,41 @@
+/*
+ * 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.contribution.jee.impl;
+
+import org.apache.tuscany.sca.contribution.Contribution;
+import org.apache.tuscany.sca.contribution.java.ContributionClassLoaderProvider;
+import org.apache.tuscany.sca.contribution.java.impl.ContributionClassLoader;
+import org.apache.tuscany.sca.core.ExtensionPointRegistry;
+
+/**
+ * The default implementation of the ContributionClassLoaderProvider
+ */
+public class JEEClassLoaderProvider implements ContributionClassLoaderProvider {
+
+    public JEEClassLoaderProvider(ExtensionPointRegistry registry) {
+        super();
+    }
+
+    public ClassLoader getClassLoader(Contribution contribution, ClassLoader parent) {
+        ContributionClassLoader ccl = new ContributionClassLoader(contribution, parent);
+        return new JEEClassLoader(contribution, ccl);
+    }
+
+}
diff --git a/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JavaEEIntrospectorImpl.java b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JavaEEIntrospectorImpl.java
index 38a1573e63..b159a21fb2 100644
--- a/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JavaEEIntrospectorImpl.java
+++ b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/JavaEEIntrospectorImpl.java
@@ -89,6 +89,7 @@ public class JavaEEIntrospectorImpl implements JavaEEIntrospector {
 
         WebApp webApp = webModule.getWebApp();
         ClassLoader classLoader = webModule.getClassLoader();
+        wmInfo.setmoduleClassloader(classLoader);
 
         // Process Remote EJB References
         for (Map.Entry<String, EjbRef> entry : webApp.getEjbRefMap().entrySet()) {
diff --git a/branches/sca-java-1.x/modules/contribution-java/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.java.ContributionClassLoaderProvider b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.java.ContributionClassLoaderProvider
index a50d8e77a4..3f309774aa 100644
--- a/branches/sca-java-1.x/modules/contribution-java/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.java.ContributionClassLoaderProvider
+++ b/branches/sca-java-1.x/modules/contribution-jee-impl/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.java.ContributionClassLoaderProvider
@@ -14,4 +14,4 @@
 # KIND, either express or implied.  See the License for the

 # specific language governing permissions and limitations

 # under the License. 

-# org.apache.tuscany.sca.contribution.java.DefaultContributionClassLoaderProvider
\ No newline at end of file
+org.apache.tuscany.sca.contribution.jee.impl.JEEClassLoaderProvider
\ No newline at end of file
diff --git a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/EjbModuleInfo.java b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/EjbModuleInfo.java
index bea6412c97..00f7011111 100644
--- a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/EjbModuleInfo.java
+++ b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/EjbModuleInfo.java
@@ -30,6 +30,9 @@ public interface EjbModuleInfo {
     
     String getModuleName();
     void setModuleName(String moduleName);
+    
+    ClassLoader getModuleClassloader();
+    void setmoduleClassloader(ClassLoader classLoader);
 
     Map<String, EjbInfo> getEjbInfos();
     EjbInfo getEjbInfo(String beanName);
diff --git a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/WebModuleInfo.java b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/WebModuleInfo.java
index 702a2728b1..79e9019b11 100644
--- a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/WebModuleInfo.java
+++ b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/WebModuleInfo.java
@@ -32,6 +32,9 @@ public interface WebModuleInfo {
     String getModuleName();
     void setModuleName(String moduleName);
     
+    ClassLoader getModuleClassloader();
+    void setmoduleClassloader(ClassLoader classLoader);
+    
     Map<String, EjbReferenceInfo> getEjbReferences();
     Map<String, EnvEntryInfo> getEnvEntries();
     
diff --git a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/EjbModuleInfoImpl.java b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/EjbModuleInfoImpl.java
index 22d0dec187..830aa81b19 100644
--- a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/EjbModuleInfoImpl.java
+++ b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/EjbModuleInfoImpl.java
@@ -29,6 +29,7 @@ public class EjbModuleInfoImpl implements EjbModuleInfo {
 
     private URI uri;
     private String moduleName;
+    private ClassLoader moduleClassLoader;
     private Map<String, EjbInfo> ejbInfos = new HashMap<String, EjbInfo>();
     
     public EjbInfo getEjbInfo(String beanName) {
@@ -54,4 +55,12 @@ public class EjbModuleInfoImpl implements EjbModuleInfo {
     public void setUri(URI uri) {
         this.uri = uri;
     }
+    
+    public ClassLoader getModuleClassloader() {
+        return moduleClassLoader;
+    }
+    
+    public void setmoduleClassloader(ClassLoader classLoader) {
+        this.moduleClassLoader = classLoader;        
+    }    
 }
diff --git a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/WebModuleInfoImpl.java b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/WebModuleInfoImpl.java
index 45d6290a06..ceca698356 100644
--- a/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/WebModuleInfoImpl.java
+++ b/branches/sca-java-1.x/modules/contribution-jee/src/main/java/org/apache/tuscany/sca/contribution/jee/impl/WebModuleInfoImpl.java
@@ -33,6 +33,7 @@ public class WebModuleInfoImpl implements WebModuleInfo {
     
     private URI uri;
     private String moduleName;
+    private ClassLoader moduleClassLoader;
     
     private Collection<Class<?>> servletClasses = new ArrayList<Class<?>>();
     private Collection<Class<?>> listenerClasses = new ArrayList<Class<?>>();
@@ -97,4 +98,12 @@ public class WebModuleInfoImpl implements WebModuleInfo {
     public void setUri(URI uri) {
         this.uri = uri;
     }
+    
+    public ClassLoader getModuleClassloader() {
+        return moduleClassLoader;
+    }
+    
+    public void setmoduleClassloader(ClassLoader classLoader) {
+        this.moduleClassLoader = classLoader;        
+    }
 }