org.gvsig.andami.plugins

Class PluginClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.gvsig.andami.plugins.PluginClassLoader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class PluginClassLoader
extends java.net.URLClassLoader

Class loader which loads the classes requested by the plugins. It first tries to search in the classpath, then it requests the class to the parent classloader, then it searches in the owns plugins' library dir, and if all these methods fail, it tries to load the class from any of the depended plugins. Finally, if this also fails, the other classloaders provided in the addLoaders method are requested to load the class.

The class loader can also be used to load resources from the plugin's directory by using the getResource() method.

Constructor Summary

Constructors

Constructor and Description
PluginClassLoader(java.net.URL[] jars, java.lang.String baseDir, java.lang.ClassLoader cl, java.util.List<PluginClassLoader> pluginLoaders)
PluginClassLoader(java.net.URL[] jars, java.lang.String baseDir, java.lang.ClassLoader cl, PluginClassLoader[] pluginLoaders) Creates a new PluginClassLoader object.

Method Summary

Modifier and Type	Method and Description
static void	addLoaders(java.util.ArrayList classLoaders) Adds other classloader to use when all the normal methods fail.
void	addPluginClassLoader(PluginClassLoader pluginClassLoader)
void	addURL(java.net.URL url)
java.lang.String	getBaseDir() Gets the plugin's base Iterator>dir, the directory which will be used to search resources.
protected java.security.PermissionCollection	getPermissions(java.security.CodeSource codesource)
java.lang.String	getPluginName() Returns the name of the plugin (the name of the directory containing the plugin).
java.net.URL	getResource(java.lang.String res) Gets the requested resource.
java.util.Enumeration<java.net.URL>	getResources(java.lang.String name)
protected java.util.Enumeration<java.net.URL>	getResources(java.lang.String name, java.util.HashSet<PluginClassLoader> visitedPlugins)
protected java.lang.Class	loadClass(java.lang.String name, boolean resolve) Carga la clase
protected java.lang.Class	singleLoadClass(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.net.URLClassLoader

close, definePackage, findClass, findResource, findResources, getResourceAsStream, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginClassLoader

public PluginClassLoader(java.net.URL[] jars,
                         java.lang.String baseDir,
                         java.lang.ClassLoader cl,
                         PluginClassLoader[] pluginLoaders)
                  throws java.io.IOException

Creates a new PluginClassLoader object.

Parameters:

jars - Array with the search paths where classes will be searched

baseDir - Base directory for this plugin. This is the directory which will be used as basedir in the getResources method.

cl - The parent classloader of this classloader. It will be used to search classes before trying to search in the plugin's directory

pluginLoaders - The classloaders of the depended plugins.

Throws:

java.io.IOException

PluginClassLoader

public PluginClassLoader(java.net.URL[] jars,
                         java.lang.String baseDir,
                         java.lang.ClassLoader cl,
                         java.util.List<PluginClassLoader> pluginLoaders)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

singleLoadClass

protected java.lang.Class singleLoadClass(java.lang.String name)
                                   throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

loadClass

protected java.lang.Class loadClass(java.lang.String name,
                                    boolean resolve)
                             throws java.lang.ClassNotFoundException

Carga la clase

Overrides:

loadClass in class java.lang.ClassLoader

Parameters:

name - Nombre de la clase

resolve - Si se ha de resolver la clase o no

Returns:

Clase cargada

Throws:

java.lang.ClassNotFoundException - Si no se pudo encontrar la clase

getResource

public java.net.URL getResource(java.lang.String res)

Gets the requested resource. If the path is relative, its base directory will be the one provided in the PluginClassLoader's constructor. If the resource is not found, search in dependents plugins, otherwise the parent classloader will be invoked to try to get it. If it is not found, it will return null.

Overrides:

getResource in class java.lang.ClassLoader

Parameters:

res - An absolute or relative path to the requested resource.

Returns:

Resource's URL if it was found, nul otherwise.

getResources

public java.util.Enumeration<java.net.URL> getResources(java.lang.String name)
                                                 throws java.io.IOException

Overrides:

getResources in class java.lang.ClassLoader

Throws:

java.io.IOException

getResources

protected java.util.Enumeration<java.net.URL> getResources(java.lang.String name,
                                                           java.util.HashSet<PluginClassLoader> visitedPlugins)
                                                    throws java.io.IOException

Throws:

java.io.IOException

getPluginName

public java.lang.String getPluginName()

Returns the name of the plugin (the name of the directory containing the plugin).

Returns:

An String containing the plugin's name.

getPermissions

protected java.security.PermissionCollection getPermissions(java.security.CodeSource codesource)

Overrides:

getPermissions in class java.net.URLClassLoader

getBaseDir

public java.lang.String getBaseDir()

Gets the plugin's base Iterator>dir, the directory which will be used to search resources.

Returns:

Returns the baseDir.

addLoaders

public static void addLoaders(java.util.ArrayList classLoaders)

Adds other classloader to use when all the normal methods fail.

Parameters:

classLoaders - An ArrayList of ClassLoaders which will be used to load classes when all the normal methods fail.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addPluginClassLoader

public void addPluginClassLoader(PluginClassLoader pluginClassLoader)

addURL

public void addURL(java.net.URL url)

Overrides:

addURL in class java.net.URLClassLoader