alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans;

import java.net.URL;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.jar.Attributes;
import java.util.jar.Attributes.Name;
import java.util.zip.ZipEntry;
import java.io.*;
import java.net.MalformedURLException;
import java.security.*;
import java.security.cert.Certificate;
import java.util.*;

/**
 * A ProxyClassLoader capable of loading classes from a set of jar files
 * and local directories.
 *
 * @author  Petr Nejedly
 */
public class JarClassLoader extends ProxyClassLoader {
    private Source[] sources;
    /** temp copy JARs which ought to be deleted */
    private Set deadJars = null; // Set
    private static final boolean VERBOSE =
        Boolean.getBoolean("netbeans.classloader.verbose"); // NOI18N
    
    /** Creates new JarClassLoader.
     * Gives transitive flag as true.
     */
    public JarClassLoader (List files, ClassLoader[] parents) {
        this(files, parents, true);
    }
    
    /** Creates new JarClassLoader.
     * @since org.netbeans.core/1 > 1.6
     * @see ProxyClassLoader#ProxyClassLoader(ClassLoader[],boolean)
     */
    public JarClassLoader(List files, ClassLoader[] parents, boolean transitive) {
        super(parents, transitive);

        sources = new Source[files.size()];
        try {
            int i=0;
            for (Iterator it = files.iterator(); it.hasNext(); i++ ) {
                Object act = it.next();
                if (act instanceof File) {
                    sources[i] = new DirSource((File)act);
                } else {
                    sources[i] = new JarSource((JarFile)act);
                }
            }
        } catch (MalformedURLException exc) {
            throw new IllegalArgumentException(exc.getMessage());
        }
            
    }
    
    /** Boot classloader needs to add entries for netbeans.user later.
     */
    final void addSources (List newSources) {
        ArrayList l = new ArrayList (sources.length + newSources.size ());
        l.addAll (Arrays.asList (sources));
        try {
            int i=0;
            for (Iterator it = newSources.iterator(); it.hasNext(); i++ ) {
                Object act = it.next();
                if (act instanceof File) {
                    l.add (new DirSource((File)act));
                } else {
                    l.add (new JarSource((JarFile)act));
                }
            }
        } catch (MalformedURLException exc) {
            throw new IllegalArgumentException(exc.getMessage());
        }
        sources = (Source[])l.toArray (sources);
    }

    /** Allows to specify the right permissions, OneModuleClassLoader does it differently.
     */
    protected PermissionCollection getPermissions( CodeSource cs ) {           
        return Policy.getPolicy().getPermissions(cs);       
    }        
    
    
    protected Package definePackage(String name, Manifest man, URL url)
	throws IllegalArgumentException
    {
        if (man == null ) {
            return definePackage(name, null, null, null, null, null, null, null);
        }
        
	String path = name.replace('.', '/').concat("/"); // NOI18N
	Attributes spec = man.getAttributes(path);
        Attributes main = man.getMainAttributes();
	
        String specTitle = getAttr(spec, main, Name.SPECIFICATION_TITLE);
        String implTitle = getAttr(spec, main, Name.IMPLEMENTATION_TITLE);
        String specVersion = getAttr(spec, main, Name.SPECIFICATION_VERSION);
        String implVersion = getAttr(spec, main, Name.IMPLEMENTATION_VERSION);
        String specVendor = getAttr(spec, main, Name.SPECIFICATION_VENDOR);
        String implVendor = getAttr(spec, main, Name.IMPLEMENTATION_VENDOR);
        String sealed      = getAttr(spec, main, Name.SEALED);

        URL sealBase = "true".equalsIgnoreCase(sealed) ? url : null; // NOI18N
	return definePackage(name, specTitle, specVersion, specVendor,
			     implTitle, implVersion, implVendor, sealBase);
    }

    private static String getAttr(Attributes spec, Attributes main, Name name) {
        String val = null;
        if (spec != null) val = spec.getValue (name);
        if (val == null && main != null) val = main.getValue (name);
        return val;
    }

    protected Class simpleFindClass(String name, String path, String pkgnameSlashes) {
        // look up the Sources and return a class based on their content
        for( int i=0; i
        try {
            for (int i = 0; i < sources.length; i++) {
                if (sources[i] instanceof JarSource) {
                    JarFile origJar = ((JarSource)sources[i]).getJarFile();
                    File orig = new File(origJar.getName());
                    if (!orig.isFile()) {
                        // Can happen when a test module is deleted:
                        // the physical JAR has already been deleted
                        // when the module was disabled. In this case it
                        // is possible that a classloader request for something
                        // in the JAR could still come in. Does it matter?
                        // See comment in Module.cleanup.
                        continue;
                    }
                    String name = orig.getName();
                    String prefix, suffix;
                    int idx = name.lastIndexOf('.');
                    if (idx == -1) {
                        prefix = name;
                        suffix = null;
                    } else {
                        prefix = name.substring(0, idx);
                        suffix = name.substring(idx);
                    }
                    while (prefix.length() < 3) prefix += "x"; // NOI18N
                    File temp = File.createTempFile(prefix, suffix);
                    temp.deleteOnExit();
                    InputStream is = new FileInputStream(orig);
                    try {
                        OutputStream os = new FileOutputStream(temp);
                        try {
                            byte[] buf = new byte[4096];
                            int j;
                            while ((j = is.read(buf)) != -1) {
                                os.write(buf, 0, j);
                            }
                        } finally {
                            os.close();
                        }
                    } finally {
                        is.close();
                    }
                    // Don't use OPEN_DELETE even though it sounds like a good idea.
                    // Can cause real problems under 1.4; see Module.java.
                    JarFile tempJar = new JarFile(temp);
                    origJar.close();
                    deadJars.add(tempJar);
                    sources[i] = new JarSource(tempJar);
                    log("#21114: replacing " + orig + " with " + temp);
                }
            }
        } catch (IOException ioe) {
            JarClassLoader.notify(0, ioe);
        }
    }
    
    /** Delete any temporary JARs we were holding on to.
     * Also close any other JARs in our list.
     */
    protected void finalize() throws Throwable {
        super.finalize();
        for (int i = 0; i < sources.length; i++) {
            if (sources[i] instanceof JarSource) {
                JarFile j = ((JarSource)sources[i]).getJarFile();
                File f = new File(j.getName());
                j.close();
                if (deadJars != null && deadJars.contains(j)) {
                    log("#21114: closing and deleting temporary JAR " + f);
                    if (f.isFile() && !f.delete()) {
                        log("(but failed to delete it)");
                    }
                }
            }
        }
    }

    abstract class Source {
        private URL url;
        private ProtectionDomain pd;
        
        public Source(URL url) {
            this.url = url;
        }
        
        public final URL getURL() {
            return url;
        }
        
        public final ProtectionDomain getProtectionDomain() {
            if (pd == null) {
                CodeSource cs = new CodeSource(url, new Certificate[0]);
                pd = new ProtectionDomain(cs, getPermissions(cs));
            }
            return pd;
        }
  
        public final URL getResource(String name) {
            try {
                return doGetResource(name);
            } catch (Exception e) {
                // can't get the resource. E.g. already closed JarFile
                log(e.toString());
            }
            return null;
        }
        
        protected abstract URL doGetResource(String name) throws MalformedURLException;
        
        public final byte[] getClassData(String name, String path) {
            try {
                return readClass(name, path);
            } catch (IOException e) {
                log(e.toString());
            }
            return null;
        }

        protected abstract byte[] readClass(String name, String path) throws IOException;

        public Manifest getManifest() {
            return null;
        }
    }

    class JarSource extends Source {
        JarFile src;
        private String resPrefix;
        
        public JarSource(JarFile file) throws MalformedURLException {
            super(new File(file.getName()).toURI().toURL());
            src = file;
            resPrefix = "jar:" + new File(src.getName()).toURI() + "!/"; // NOI18N;
        }

        public Manifest getManifest() {
            try {
                return src.getManifest();
            } catch (IOException e) {
                return null;
            }
        }
        
        JarFile getJarFile() {
            return src;
        }
        
        protected URL doGetResource(String name) throws MalformedURLException {
            ZipEntry ze;
            try {
                ze = src.getEntry(name);
            } catch (IllegalStateException ex) {
                // this exception occurs in org/netbeans/core/lookup/* tests
                // without this catch statement the tests fail
                return null;
            }
            if (VERBOSE) {
                if (ze != null)
                    System.err.println("Loading " + name + " from " + src.getName()); // NOI18N
            }
            return ze == null ? null : new URL(resPrefix + ze.getName());
        }
        
        protected byte[] readClass(String name, String path) throws IOException {
            ZipEntry ze;
            try {
                ze = src.getEntry(path);
            } catch (IllegalStateException ex) {
                // this exception occurs in org/netbeans/core/lookup/* tests
                // without this catch statement the tests fail
                return null;
            }
            if (ze == null) return null;
            if (VERBOSE) {
                System.err.println("Loading " + path + " from " + src.getName()); // NOI18N
            }
            
            int len = (int)ze.getSize();
            byte[] data = new byte[len];
            InputStream is = src.getInputStream(ze);
            int count = 0;
            while (count < len) {
                count += is.read(data, count, len-count);
            }
            return data;
        }
    }

    class DirSource extends Source {
        File dir;
        
        public DirSource(File file) throws MalformedURLException {
            super(file.toURI().toURL());
            dir = file;
        }

        protected URL doGetResource(String name) throws MalformedURLException {
            File resFile = new File(dir, name);
            return resFile.exists() ? resFile.toURI().toURL() : null;
        }
        
        protected byte[] readClass(String name, String path) throws IOException {
            File clsFile = new File(dir, path.replace('/', File.separatorChar));
            if (!clsFile.exists()) return null;
            
            int len = (int)clsFile.length();
            byte[] data = new byte[len];
            InputStream is = new FileInputStream(clsFile);
            int count = 0;
            while (count < len) {
                count += is.read(data, count, len-count);
            }
            return data;
        }
        
    }
    
    //
    // ErrorManager's methods
    // (do not want to depend on ErrorManager however)
    //
    
    static void log (String msg) {
        if ("0".equals(System.getProperty("org.netbeans.core.modules"))) { // NOI18N
            System.err.println(msg);
        }
    }
    
    static Throwable annotate (
        Throwable t, int x, String s, Object o1, Object o2, Object o3
    ) {
        System.err.println("annotated: " + t.getMessage () + " - " + s); // NOI18N
        return t;
    }
    
    static void notify (int x, Throwable t) {
        t.printStackTrace();
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.