org.apache.xbean.osgi.bundle.util

Class BundleClassLoader

java.lang.Object

java.lang.ClassLoader

org.apache.xbean.osgi.bundle.util.BundleClassLoader

All Implemented Interfaces:

DelegatingBundleReference, org.osgi.framework.BundleReference

Direct Known Subclasses:

BundleResourceClassLoader

public class BundleClassLoader
extends ClassLoader
implements DelegatingBundleReference

ClassLoader for a Bundle.
In OSGi, resource lookup on resources in the META-INF directory using Bundle.getResource(String) or Bundle.getResources(String) does not return the resources found in the wired bundles of the bundle (wired via Import-Package or DynamicImport-Package). This class loader implementation provides #getResource(String) and {@link #getResources(String)} methods that do delegate such resource lookups to the wired bundles.
The URLs returned by {@link Bundle#getResource(String)} or {@link Bundle#getResources(String)} methods are OSGi framework specific "bundle" URLs. This sometimes can cause problems with 3rd party libraries which do not understand how to interpret the "bundle" URLs. This ClassLoader implementation, if enabled, can return jar URLs for resources found in embedded jars in the bundle. If a resource is found within a directory in the bundle the URL returned for that resource is unconverted.

Version:

$Rev: 1163514 $ $Date: 2011-08-31 00:37:38 -0700 (Wed, 31 Aug 2011) $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.Bundle	bundle
protected BundleResourceHelper	resourceHelper

Constructor Summary

Constructors

Constructor and Description
BundleClassLoader(org.osgi.framework.Bundle bundle)
BundleClassLoader(org.osgi.framework.Bundle bundle, boolean searchWiredBundles)
BundleClassLoader(org.osgi.framework.Bundle bundle, boolean searchWiredBundles, boolean convertResourceUrls)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
Enumeration<URL>	findResources(String name)
org.osgi.framework.Bundle	getBundle() Return the bundle associated with this classloader.
org.osgi.framework.Bundle	getBundle(boolean unwrap) Return the bundle associated with this classloader.
boolean	getConvertResourceUrls()
URL	getResource(String name)
Enumeration<URL>	getResources(String name)
boolean	getSearchWiredBundles()
int	hashCode()
protected Class<?>	loadClass(String name, boolean resolve)
void	setConvertResourceUrls(boolean convert)
void	setSearchWiredBundles(boolean search)
String	toString()

Methods inherited from class java.lang.ClassLoader

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bundle

protected final org.osgi.framework.Bundle bundle

resourceHelper

protected final BundleResourceHelper resourceHelper

Constructor Detail

BundleClassLoader

public BundleClassLoader(org.osgi.framework.Bundle bundle)

BundleClassLoader

public BundleClassLoader(org.osgi.framework.Bundle bundle,
                 boolean searchWiredBundles)

BundleClassLoader

public BundleClassLoader(org.osgi.framework.Bundle bundle,
                 boolean searchWiredBundles,
                 boolean convertResourceUrls)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

loadClass

protected Class<?> loadClass(String name,
                 boolean resolve)
                      throws ClassNotFoundException

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

getResource

public URL getResource(String name)

Overrides:

getResource in class ClassLoader

getResources

public Enumeration<URL> getResources(String name)
                              throws IOException

Overrides:

getResources in class ClassLoader

Throws:

IOException

findResources

public Enumeration<URL> findResources(String name)
                               throws IOException

Overrides:

findResources in class ClassLoader

Throws:

IOException

setSearchWiredBundles

public void setSearchWiredBundles(boolean search)

getSearchWiredBundles

public boolean getSearchWiredBundles()

setConvertResourceUrls

public void setConvertResourceUrls(boolean convert)

getConvertResourceUrls

public boolean getConvertResourceUrls()

getBundle

public org.osgi.framework.Bundle getBundle(boolean unwrap)

Return the bundle associated with this classloader. In most cases the bundle associated with the classloader is a regular framework bundle. However, in some cases the bundle associated with the classloader is a DelegatingBundle. In such cases, the unwrap parameter controls whether this function returns the DelegatingBundle instance or the main application bundle backing with the DelegatingBundle.

Specified by:

getBundle in interface DelegatingBundleReference

Parameters:

unwrap - If true and if the bundle associated with this classloader is a DelegatingBundle, this function will return the main application bundle backing with the DelegatingBundle. Otherwise, the bundle associated with this classloader is returned as is.

Returns:

The bundle associated with this classloader.

getBundle

public org.osgi.framework.Bundle getBundle()

Return the bundle associated with this classloader. This method calls getBundle(true) and therefore always returns a regular framework bundle.

Note: Some libraries use BundleReference.getBundle() to obtain a bundle for the given classloader and expect the returned bundle instance to be work with any OSGi API. Some of these API might not work if DelegatingBundle is returned. That is why this function will always return a regular framework bundle. See getBundle(boolean) for more information.

Specified by:

getBundle in interface org.osgi.framework.BundleReference

Returns:

The bundle associated with this classloader.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object