org.eclipse.osgi.framework.adaptor
Interface BundleClassLoader

All Superinterfaces:

BundleReference

All Known Subinterfaces:

BaseClassLoader, ParallelClassLoader

All Known Implementing Classes:

CompositeClassLoader, DefaultClassLoader

public interface BundleClassLoader
extends BundleReference

The BundleClassLoader interface is used by the Framework to load local classes and resources from a Bundle. Classes that implement this interface must extend java.lang.ClassLoader, either directly or by extending a subclass of java.lang.ClassLoader.

ClassLoaders that implement the BundleClassLoader interface must use a ClassLoaderDelegate to delegate all class, resource and native library lookups.

Clients may implement this interface.

Since:

3.1

See Also:

BundleData.createClassLoader(ClassLoaderDelegate, BundleProtectionDomain, String[])

Method Summary

void	attachFragment(BundleData bundledata, ProtectionDomain domain, String[] classpath) Attaches the BundleData for a fragment to this BundleClassLoader.
void	close() Closes this class loader.
List<URL>	findEntries(String path, String filePattern, int options) Returns resource entries for the bundle associated with this class loader.
Class<?>	findLocalClass(String classname) Finds a local class in the BundleClassLoader without consulting the delegate.
URL	findLocalResource(String resource) Finds a local resource in the BundleClassLoader without consulting the delegate.
Enumeration<URL>	findLocalResources(String resource) Finds all local resources in the BundleClassLoader with the specified path without consulting the delegate.
ClassLoaderDelegate	getDelegate() Returns the ClassLoaderDelegate used by this BundleClassLoader
ClassLoader	getParent() Returns the parent classloader used by this BundleClassLoader
URL	getResource(String name) This method will first search the parent class loader for the resource; That failing, this method will invoke ClassLoaderDelegate.findResource(String) to find the resource.
Enumeration<URL>	getResources(String name) This method will first search the parent class loader for the resource; That failing, this method will invoke ClassLoaderDelegate.findResource(String) to find the resource.
void	initialize() Initializes the ClassLoader.
Collection<String>	listLocalResources(String path, String filePattern, int options) Returns the names of local resources visible to this bundle class loader.
Collection<String>	listResources(String path, String filePattern, int options) Returns the names of resources visible to this bundle class loader.
Class<?>	loadClass(String name) This method will first search the parent class loader for the class; That failing, this method will invoke ClassLoaderDelegate.findClass(String) to find the resource.

Methods inherited from interface org.osgi.framework.BundleReference

getBundle

Method Detail

initialize

void initialize()

Initializes the ClassLoader. This is called after all currently resolved fragment bundles have been attached to the BundleClassLoader by the Framework.

findLocalResource

URL findLocalResource(String resource)

Finds a local resource in the BundleClassLoader without consulting the delegate.

Parameters:

resource - the resource path to find.

Returns:

a URL to the resource or null if the resource does not exist.

findLocalResources

Enumeration<URL> findLocalResources(String resource)

Finds all local resources in the BundleClassLoader with the specified path without consulting the delegate.

Parameters:

resource - the resource path to find.

Returns:

An Enumeration of all resources found or null if the resource. does not exist.

findLocalClass

Class<?> findLocalClass(String classname)
                        throws ClassNotFoundException

Finds a local class in the BundleClassLoader without consulting the delegate.

Parameters:

classname - the classname to find.

Returns:

The class object found.

Throws:

ClassNotFoundException - if the classname does not exist locally.

getResource

URL getResource(String name)

This method will first search the parent class loader for the resource; That failing, this method will invoke ClassLoaderDelegate.findResource(String) to find the resource.

Parameters:

name - the resource path to get.

Returns:

a URL for the resource or null if the resource is not found.

getResources

Enumeration<URL> getResources(String name)
                              throws IOException

This method will first search the parent class loader for the resource; That failing, this method will invoke ClassLoaderDelegate.findResource(String) to find the resource.

Parameters:

name - the resource path to get.

Returns:

an Enumeration of URL objects for the resource or null if the resource is not found.

Throws:

IOException

loadClass

Class<?> loadClass(String name)
                   throws ClassNotFoundException

This method will first search the parent class loader for the class; That failing, this method will invoke ClassLoaderDelegate.findClass(String) to find the resource.

Parameters:

name - the class name to load.

Returns:

the Class.

Throws:

ClassNotFoundException

close

void close()

Closes this class loader. After this method is called loadClass will always throw ClassNotFoundException, getResource, getResourceAsStream, getResources and will return null.

attachFragment

void attachFragment(BundleData bundledata,
                    ProtectionDomain domain,
                    String[] classpath)

Attaches the BundleData for a fragment to this BundleClassLoader. The Fragment BundleData resources must be appended to the end of this BundleClassLoader's classpath. Fragment BundleData resources must be searched ordered by Bundle ID's.

Parameters:

bundledata - The BundleData of the fragment.

domain - The ProtectionDomain of the resources of the fragment. Any classes loaded from the fragment's BundleData must belong to this ProtectionDomain.

classpath - An array of Bundle-ClassPath entries to use for loading classes and resources. This is specified by the Bundle-ClassPath manifest entry of the fragment.

getDelegate

ClassLoaderDelegate getDelegate()

Returns the ClassLoaderDelegate used by this BundleClassLoader

Returns:

the ClassLoaderDelegate used by this BundleClassLoader

getParent

ClassLoader getParent()

Returns the parent classloader used by this BundleClassLoader

Returns:

the parent classloader used by this BundleClassLoader

findEntries

List<URL> findEntries(String path,
                      String filePattern,
                      int options)

Returns resource entries for the bundle associated with this class loader. This is used to answer a call to the BundleWiring.findEntries(String, String, int) method.

Parameters:

path - The path name in which to look.

filePattern - The file name pattern for selecting resource names in the specified path.

options - The options for listing resource names.

Returns:

a list of resource URLs. If no resources are found then the empty list is returned.

See Also:

BundleWiring#findEntries(String, String, int)}

listResources

Collection<String> listResources(String path,
                                 String filePattern,
                                 int options)

Returns the names of resources visible to this bundle class loader. This is used to answer a call to the BundleWiring.listResources(String, String, int) method. This method should simply return the result of calling ClassLoaderDelegate.listResources(String, String, int)

Parameters:

path - The path name in which to look.

filePattern - The file name pattern for selecting resource names in the specified path.

options - The options for listing resource names.

Returns:

a collection of resource names. If no resources are found then the empty collection is returned.

See Also:

BundleWiring#listResources(String, String, int)}, ClassLoaderDelegate#listResources(String, String, int)}

listLocalResources

Collection<String> listLocalResources(String path,
                                      String filePattern,
                                      int options)

Returns the names of local resources visible to this bundle class loader. Only the resources available on the local class path of this bundle class loader are searched.

Parameters:

path - The path name in which to look.

filePattern - The file name pattern for selecting resource names in the specified path.

options - The options for listing resource names.

Returns:

a collection of resource names. If no resources are found then the empty collection is returned.

See Also:

ClassLoaderDelegate#listResources(String, String, int)}