org.apache.xbean.osgi.bundle.util

Class BundleResourceHelper

java.lang.Object

org.apache.xbean.osgi.bundle.util.BundleResourceHelper

Direct Known Subclasses:

EquinoxBundleResourceHelper

public class BundleResourceHelper
extends Object

Helper for finding resources in 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 META-INF 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. If enabled, this helper can convert the framework specific URLs into regular jar URLs.

Version:

$Rev: 1331428 $ $Date: 2012-04-27 15:39:19 +0200 (Fri, 27 Apr 2012) $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.Bundle	bundle
static String	CONVERT_RESOURCE_URLS
protected boolean	convertResourceUrls
static String	SEARCH_WIRED_BUNDLES
protected boolean	searchWiredBundles

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected URL	convert(URL url)
protected URL	convertedFindResource(String name) Lookup resource and return converted URL (in a generic way).
protected Enumeration<URL>	convertedFindResources(String name) Lookup resources and return converted URLs (in a generic way).
protected URL	findResource(String name)
protected Enumeration<URL>	findResources(String name)
boolean	getConvertResourceUrls()
static boolean	getConvertResourceUrls(boolean defaultValue)
URL	getResource(String name)
Enumeration<URL>	getResources(String name)
boolean	getSearchWiredBundles()
static boolean	getSearchWiredBundles(boolean defaultValue)
void	setConvertResourceUrls(boolean convert)
void	setSearchWiredBundles(boolean search)

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_WIRED_BUNDLES

public static final String SEARCH_WIRED_BUNDLES

CONVERT_RESOURCE_URLS

public static final String CONVERT_RESOURCE_URLS

bundle

protected final org.osgi.framework.Bundle bundle

searchWiredBundles

protected boolean searchWiredBundles

convertResourceUrls

protected boolean convertResourceUrls

Constructor Detail

BundleResourceHelper

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

BundleResourceHelper

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

Method Detail

setSearchWiredBundles

public void setSearchWiredBundles(boolean search)

getSearchWiredBundles

public boolean getSearchWiredBundles()

setConvertResourceUrls

public void setConvertResourceUrls(boolean convert)

getConvertResourceUrls

public boolean getConvertResourceUrls()

getResource

public URL getResource(String name)

getResources

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

Throws:

IOException

convert

protected URL convert(URL url)

findResource

protected URL findResource(String name)

findResources

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

Throws:

IOException

convertedFindResource

protected URL convertedFindResource(String name)

Lookup resource and return converted URL (in a generic way).

Parameters:

name -

Returns:

convertedFindResources

protected Enumeration<URL> convertedFindResources(String name)
                                           throws IOException

Lookup resources and return converted URLs (in a generic way).

Parameters:

name -

Returns:

Throws:

IOException

getSearchWiredBundles

public static boolean getSearchWiredBundles(boolean defaultValue)

getConvertResourceUrls

public static boolean getConvertResourceUrls(boolean defaultValue)