org.eclipse.osgi.framework.adaptor

Interface BundleData

All Superinterfaces:

BundleReference

All Known Implementing Classes:

BaseData, SystemBundleData

public interface BundleData
extends BundleReference

The BundleData represents a single bundle that is persistently stored by a FrameworkAdaptor. A BundleData creates the ClassLoader for a bundle, finds native libraries installed in the FrameworkAdaptor for the bundle, creates data files for the bundle, used to access bundle entries, manifest information, and getting and saving metadata.

Clients may implement this interface.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BOOTCLASSPATH_EXTENSION The BundleData is for a bootclasspath extension bundle
static int	TYPE_COMPOSITEBUNDLE The BundleData is for a composite bundle
static int	TYPE_EXTCLASSPATH_EXTENSION The BundleData is for an extension classpath bundle
static int	TYPE_FRAGMENT The BundleData is for a fragment bundle
static int	TYPE_FRAMEWORK_EXTENSION The BundleData is for a framework extension bundle
static int	TYPE_SINGLETON The BundleData is for a singleton bundle
static int	TYPE_SURROGATEBUNDLE The BundleData is for a composite bundle surrogate

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close all resources for this BundleData
BundleClassLoader	createClassLoader(ClassLoaderDelegate delegate, BundleProtectionDomain domain, String[] bundleclasspath) Creates the ClassLoader for the BundleData.
String	findLibrary(String libname) Returns the absolute path name of a native library.
Enumeration<URL>	findLocalResources(String path) Finds local resources by searching the class path of this bundle data.
String	getActivator() Returns the Bundle-Activator for this BundleData as specified in the bundle manifest file.
long	getBundleID() Get the BundleData bundle ID.
String[]	getClassPath() Returns the Bundle-ClassPath for this BundleData as specified in the bundle manifest file.
File	getDataFile(String path) Return the bundle data directory.
String	getDynamicImports() Returns the DynamicImport-Package for this BundleData as specified in the bundle manifest file.
URL	getEntry(String path) Gets a URL to the bundle entry specified by path.
Enumeration<String>	getEntryPaths(String path) Gets all of the bundle entries that exist under the specified path.
String	getExecutionEnvironment() Returns the Bundle-RequiredExecutionEnvironment for this BundleData as specified in the bundle manifest file.
long	getLastModified() Get the last time this BundleData was modified.
String	getLocation() Get the BundleData Location.
Dictionary<String,String>	getManifest() Return the Dictionary of manifest headers for the BundleData.
int	getStartLevel() Returns the start level metadata for this BundleData.
int	getStatus() Returns the status metadata for this BundleData.
String	getSymbolicName() Returns the Bundle-SymbolicName for this BundleData as specified in the bundle manifest file.
int	getType() Returns the type of bundle this BundleData is for.
Version	getVersion() Returns the Bundle-Version for this BundleData as specified in the bundle manifest file.
void	installNativeCode(String[] nativepaths) Installs the native code paths for this BundleData.
void	open() Open the BundleData.
void	save() Persistently stores all the metadata for this BundleData
void	setBundle(Bundle bundle) Sets the Bundle object for this BundleData.
void	setStartLevel(int value) Sets the start level metatdata for this BundleData.
void	setStatus(int value) Sets the status metadata for this BundleData.

Methods inherited from interface org.osgi.framework.BundleReference

getBundle

Field Detail

TYPE_FRAGMENT

static final int TYPE_FRAGMENT

The BundleData is for a fragment bundle

See Also:

Constant Field Values

TYPE_FRAMEWORK_EXTENSION

static final int TYPE_FRAMEWORK_EXTENSION

The BundleData is for a framework extension bundle

See Also:

Constant Field Values

TYPE_BOOTCLASSPATH_EXTENSION

static final int TYPE_BOOTCLASSPATH_EXTENSION

The BundleData is for a bootclasspath extension bundle

See Also:

Constant Field Values

TYPE_SINGLETON

static final int TYPE_SINGLETON

The BundleData is for a singleton bundle

See Also:

Constant Field Values

TYPE_EXTCLASSPATH_EXTENSION

static final int TYPE_EXTCLASSPATH_EXTENSION

The BundleData is for an extension classpath bundle

See Also:

Constant Field Values

TYPE_COMPOSITEBUNDLE

static final int TYPE_COMPOSITEBUNDLE

The BundleData is for a composite bundle

See Also:

Constant Field Values

TYPE_SURROGATEBUNDLE

static final int TYPE_SURROGATEBUNDLE

The BundleData is for a composite bundle surrogate

See Also:

Constant Field Values

Method Detail

createClassLoader

BundleClassLoader createClassLoader(ClassLoaderDelegate delegate,
                                  BundleProtectionDomain domain,
                                  String[] bundleclasspath)

Creates the ClassLoader for the BundleData. The ClassLoader created must use the ClassLoaderDelegate to delegate class, resource and library loading. The delegate is responsible for finding any resource or classes imported by the bundle through an imported package or a required bundle.

The ProtectionDomain domain must be used by the Classloader when defining a class.

Parameters:

delegate - The ClassLoaderDelegate to delegate to.

domain - The BundleProtectionDomain to use when defining a class.

bundleclasspath - An array of bundle classpaths to use to create this classloader. This is specified by the Bundle-ClassPath manifest entry.

Returns:

The new ClassLoader for the BundleData.

getEntry

URL getEntry(String path)

Gets a URL to the bundle entry specified by path. This method must not use the BundleClassLoader to find the bundle entry since the ClassLoader will delegate to find the resource.

Parameters:

path - The bundle entry path.

Returns:

A URL used to access the entry or null if the entry does not exist.

See Also:

Bundle.getEntry(String)

getEntryPaths

Enumeration<String> getEntryPaths(String path)

Gets all of the bundle entries that exist under the specified path. For example:

getEntryPaths("/META-INF")

This will return all entries from the /META-INF directory of the bundle.

Parameters:

path - The path to a directory in the bundle.

Returns:

An Enumeration of the entry paths or null if the specified path does not exist.

See Also:

Bundle.getEntryPaths(String path)

findLibrary

String findLibrary(String libname)

Returns the absolute path name of a native library. The BundleData ClassLoader invokes this method to locate the native libraries that belong to classes loaded from this BundleData. Returns null if the library does not exist in this BundleData.

Parameters:

libname - The name of the library to find the absolute path to.

Returns:

The absolute path name of the native library or null if the library does not exist.

installNativeCode

void installNativeCode(String[] nativepaths)
                       throws BundleException

Installs the native code paths for this BundleData. Each element of nativepaths must be installed for lookup when findLibrary is called.

Parameters:

nativepaths - The array of native code paths to install for the bundle.

Throws:

BundleException - If any error occurs during install.

getDataFile

File getDataFile(String path)

Return the bundle data directory. Attempt to create the directory if it does not exist.

Returns:

Bundle data directory or null if not supported.

See Also:

BundleContext.getDataFile(String)

getManifest

Dictionary<String,String> getManifest()
                                      throws BundleException

Return the Dictionary of manifest headers for the BundleData.

Returns:

Dictionary that contains the Manifest headers for the BundleData.

Throws:

BundleException - if an error occurred while reading the bundle manifest data.

getBundleID

long getBundleID()

Get the BundleData bundle ID. This will be used as the bundle ID by the framework.

Returns:

The BundleData ID.

getLocation

String getLocation()

Get the BundleData Location. This will be used as the bundle location by the framework.

Returns:

the BundleData location.

getLastModified

long getLastModified()

Get the last time this BundleData was modified.

Returns:

the last time this BundleData was modified

close

void close()
           throws IOException

Close all resources for this BundleData

Throws:

IOException - If an error occurs closing.

open

void open()
          throws IOException

Open the BundleData. This method will reopen the BundleData if it has been previously closed.

Throws:

IOException - If an error occurs opening.

setBundle

void setBundle(Bundle bundle)

Sets the Bundle object for this BundleData.

Parameters:

bundle - The Bundle Object for this BundleData.

getStartLevel

int getStartLevel()

Returns the start level metadata for this BundleData.

Returns:

the start level metadata for this BundleData.

getStatus

int getStatus()

Returns the status metadata for this BundleData. A value of 1 indicates that this bundle is started persistently. A value of 0 indicates that this bundle is not started persistently.

Returns:

the status metadata for this BundleData.

setStartLevel

void setStartLevel(int value)

Sets the start level metatdata for this BundleData. Metadata must be stored persistently when BundleData.save() is called.

Parameters:

value - the start level metadata

setStatus

void setStatus(int value)

Sets the status metadata for this BundleData. Metadata must be stored persistently when BundleData.save() is called.

Parameters:

value - the status metadata.

save

void save()
          throws IOException

Persistently stores all the metadata for this BundleData

Throws:

IOException

getSymbolicName

String getSymbolicName()

Returns the Bundle-SymbolicName for this BundleData as specified in the bundle manifest file.

Returns:

the Bundle-SymbolicName for this BundleData.

getVersion

Version getVersion()

Returns the Bundle-Version for this BundleData as specified in the bundle manifest file.

Returns:

the Bundle-Version for this BundleData.

getType

int getType()

Returns the type of bundle this BundleData is for.

Returns:

returns the type of bundle this BundleData is for

getClassPath

String[] getClassPath()
                      throws BundleException

Returns the Bundle-ClassPath for this BundleData as specified in the bundle manifest file.

Returns:

the classpath for this BundleData.

Throws:

BundleException

getActivator

String getActivator()

Returns the Bundle-Activator for this BundleData as specified in the bundle manifest file.

Returns:

the Bundle-Activator for this BundleData.

getExecutionEnvironment

String getExecutionEnvironment()

Returns the Bundle-RequiredExecutionEnvironment for this BundleData as specified in the bundle manifest file.

Returns:

the Bundle-RequiredExecutionEnvironment for this BundleData.

getDynamicImports

String getDynamicImports()

Returns the DynamicImport-Package for this BundleData as specified in the bundle manifest file.

Returns:

the DynamicImport-Packaget for this BundleData.

findLocalResources

Enumeration<URL> findLocalResources(String path)

Finds local resources by searching the class path of this bundle data.

Parameters:

path - the requested resource name.

Returns:

the requested enumeration of resource URLs or null if the resource does not exist