org.ow2.chameleon.core.utils

Class FrameworkClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.ow2.chameleon.core.utils.FrameworkClassLoader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FrameworkClassLoader
extends URLClassLoader

The classloader responsible to load the framework classes and providing access to the classes and resources from the Jar's located in the 'libs' directory. The 'libs' directory contain non-bundle jars that are scanned and 'exported' by the framework. This feature only work for Apache Felix (no Eclipse Equinox is not supported).

The Framework is loaded in a different classloader to access the jar contained in the 'libs' directory. Notice that the framework jar must be in the Chameleon's classpath.

Method Summary

Modifier and Type	Method and Description
static ClassLoader	getFrameworkClassLoader(File basedir) Gets an instance of FrameworkClassLoader.
static boolean	hasToBeDefined(String name) Checks whether or not the given class name must be defined by the .FrameworkClassLoader or by the parent class loader.
static URL[]	jars(File dir) Builds a array of URLs containing all the jar file from the given directory.
Class	loadClass(String name) Loads a class.

Methods inherited from class java.net.URLClassLoader

addURL, close, definePackage, findClass, findResource, findResources, getPermissions, 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, getResource, getResources, 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, toString, wait, wait, wait

Method Detail

getFrameworkClassLoader

public static ClassLoader getFrameworkClassLoader(File basedir)

Gets an instance of FrameworkClassLoader.

Parameters:

basedir - the base directory. The 'libs' folder must be a direct child of this directory.

Returns:

the instance of classloader.

hasToBeDefined

public static boolean hasToBeDefined(String name)

Checks whether or not the given class name must be defined by the .FrameworkClassLoader or by the parent class loader.

It checks if the class is in one of the packages listed in .FrameworkClassLoader#PREFIXES.

Parameters:

name - the class name

Returns:

true if the class must be defined by the framework's classloader, false otherwise.

loadClass

public Class loadClass(String name)
                throws ClassNotFoundException

Loads a class. If the class needs to be defined by this classloader, the byte code of the class is retrieved from the classpath and defined. Otherwise, the parent classloader is used.

If the byte code of the class cannot be found, it delegates to the parent.

Defined classes are stored, and not redefined.

Overrides:

loadClass in class ClassLoader

Parameters:

name - the class name

Returns:

the loaded class

Throws:

ClassNotFoundException - if the class cannot be found

jars

public static URL[] jars(File dir)

Builds a array of URLs containing all the jar file from the given directory. If there are no jar files in this directory or if the directory does not exist, an empty array is returned. The lookup is recursive.

Parameters:

dir - the directory

Returns:

the array of urls.