org.eclipse.osgi.baseadaptor

Class BaseAdaptor

java.lang.Object

org.eclipse.osgi.baseadaptor.BaseAdaptor

All Implemented Interfaces:

FrameworkAdaptor

public class BaseAdaptor
extends Object
implements FrameworkAdaptor

A Framework adaptor implementation that allows additional functionality to be hooked in. Hooks are configured using HookConfigurator objects. A framework extension may add hook configurators which can be used to add hooks to the HookRegistry.

Since:

3.2

See Also:

HookConfigurator, HookRegistry, AdaptorHook

Field Summary

Fields inherited from interface org.eclipse.osgi.framework.adaptor.FrameworkAdaptor

FRAMEWORK_SYMBOLICNAME

Constructor Summary

Constructors

Constructor and Description
BaseAdaptor(String[] args) Constructs a BaseAdaptor.

Method Summary

Methods

Modifier and Type	Method and Description
void	compactStorage() Compact/cleanup the persistent storage for the adaptor.
BundleFile	createBundleFile(Object content, BaseData data) Creates a bundle file object for the given content and base data.
BundleData	createSystemBundleData() Creates a BundleData object for the System Bundle.
Enumeration<URL>	findEntries(List<BundleData> datas, String path, String filePattern, int options) Returns resources entries for the specified bundle datas.
void	frameworkStart(BundleContext fwContext) This method calls all the configured adaptor hook AdaptorHook.frameworkStart(BundleContext) methods.
void	frameworkStop(BundleContext fwContext) This method calls all the configured adaptor hook AdaptorHook.frameworkStop(BundleContext) methods.
void	frameworkStopping(BundleContext fwContext) This method calls all the configured adaptor hook AdaptorHook.frameworkStopping(BundleContext) methods.
Bundle	getBundle(long id) Returns the bundle with the specified identifier.
ClassLoader	getBundleClassLoaderParent() This method calls all the configured classloading hooks ClassLoadingHook.getBundleClassLoaderParent() methods until one returns a non-null value.
BundleWatcher	getBundleWatcher() Returns the bundle watcher for this FrameworkAdaptor.
BundleContext	getContext() Returns the system bundle's context
EventPublisher	getEventPublisher() Returns the event publisher for this BaseAdaptor
FrameworkLog	getFrameworkLog() This method calls all configured adaptor hook AdaptorHook.createFrameworkLog() methods until the first one returns a non-null value.
HookRegistry	getHookRegistry() Returns the HookRegistry object for this adaptor.
int	getInitialBundleStartLevel() Returns the initial bundle start level as maintained by this adaptor
BundleData[]	getInstalledBundles() Return a list of the installed bundles.
PermissionStorage	getPermissionStorage() Returns the PermissionStorage object which will be used to to manage the permission data.
PlatformAdmin	getPlatformAdmin() Returns the PlatformAdmin for this FrameworkAdaptor.
Properties	getProperties() This method will call all the configured adaptor hook AdaptorHook.addProperties(Properties) methods.
State	getState() Returns the State for this FrameworkAdaptor.
protected BaseStorage	getStorage()
long	getTotalFreeSpace() Returns the total amount of free space available for bundle storage on the device.
void	handleRuntimeError(Throwable error) This method calls all the configured adaptor hooks AdaptorHook.handleRuntimeError(Throwable) methods.
void	initialize(EventPublisher publisher) This method will call all configured adaptor hooks AdaptorHook.initialize(BaseAdaptor) method.
void	initializeStorage() Initialize the persistent storage for the adaptor.
BundleOperation	installBundle(String location, URLConnection source) Prepare to install a bundle from a URLConnection.
boolean	isReadOnly() Returns true if the persistent storage is read-only
boolean	isStopping() Returns true if the frameworkStopping(BundleContext) method has been called
List<String>	listEntryPaths(List<BundleFile> bundleFiles, String path, String filePattern, int options) Returns the names of resources available from a list of bundle files.
URLConnection	mapLocationToURLConnection(String location) This method will call each configured adaptor hook AdaptorHook.mapLocationToURLConnection(String) method until one returns a non-null value.
void	setInitialBundleStartLevel(int value) Sets the initial bundle start level
BundleOperation	uninstallBundle(BundleData bundledata) Prepare to uninstall a bundle.
BundleOperation	updateBundle(BundleData bundledata, URLConnection source) Prepare to update a bundle from a URLConnection.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAdaptor

public BaseAdaptor(String[] args)

Constructs a BaseAdaptor.

Parameters:

args - arguments passed to the adaptor by the framework.

Method Detail

initialize

public void initialize(EventPublisher publisher)

This method will call all configured adaptor hooks AdaptorHook.initialize(BaseAdaptor) method.

Specified by:

initialize in interface FrameworkAdaptor

Parameters:

publisher - The EventPublisher used to publish any events to the framework.

See Also:

FrameworkAdaptor.initialize(EventPublisher)

initializeStorage

public void initializeStorage()
                       throws IOException

Description copied from interface: FrameworkAdaptor

Initialize the persistent storage for the adaptor.

Specified by:

initializeStorage in interface FrameworkAdaptor

Throws:

IOException - If the adaptor is unable to initialize the bundle storage.

See Also:

FrameworkAdaptor.initializeStorage()

compactStorage

public void compactStorage()
                    throws IOException

Description copied from interface: FrameworkAdaptor

Compact/cleanup the persistent storage for the adaptor.

Specified by:

compactStorage in interface FrameworkAdaptor

Throws:

IOException

See Also:

FrameworkAdaptor.compactStorage()

getProperties

public Properties getProperties()

This method will call all the configured adaptor hook AdaptorHook.addProperties(Properties) methods.

Specified by:

getProperties in interface FrameworkAdaptor

Returns:

The properties object for the adaptor.

See Also:

FrameworkAdaptor.getProperties()

getInstalledBundles

public BundleData[] getInstalledBundles()

Description copied from interface: FrameworkAdaptor

Return a list of the installed bundles. Each element in the list must be of type BundleData. Each BundleData corresponds to one bundle that is persistently stored. This method must construct BundleData objects for all installed bundles and return an array containing the objects. The returned array becomes the property of the framework.

Specified by:

getInstalledBundles in interface FrameworkAdaptor

Returns:

Array of installed BundleData objects, or null if none can be found.

See Also:

FrameworkAdaptor.getInstalledBundles()

mapLocationToURLConnection

public URLConnection mapLocationToURLConnection(String location)
                                         throws BundleException

This method will call each configured adaptor hook AdaptorHook.mapLocationToURLConnection(String) method until one returns a non-null value. If none of the adaptor hooks return a non-null value then the string is used to construct a new URL object to open a new url connection.

Specified by:

mapLocationToURLConnection in interface FrameworkAdaptor

Parameters:

location - of the bundle.

Returns:

URLConnection that represents the location.

Throws:

BundleException - if the mapping fails.

See Also:

FrameworkAdaptor.mapLocationToURLConnection(String)

installBundle

public BundleOperation installBundle(String location,
                            URLConnection source)

Description copied from interface: FrameworkAdaptor

Prepare to install a bundle from a URLConnection.

To complete the install, begin and then commit must be called on the returned BundleOperation object. If either of these methods throw a BundleException or some other error occurs, then undo must be called on the BundleOperation object to undo the change to persistent storage.

Specified by:

installBundle in interface FrameworkAdaptor

Parameters:

location - Bundle location.

source - URLConnection from which the bundle may be read. Any InputStreams returned from the source (URLConnections.getInputStream) must be closed by the BundleOperation object.

Returns:

BundleOperation object to be used to complete the install.

See Also:

FrameworkAdaptor.installBundle(String, URLConnection)

updateBundle

public BundleOperation updateBundle(BundleData bundledata,
                           URLConnection source)

Description copied from interface: FrameworkAdaptor

Prepare to update a bundle from a URLConnection.

To complete the update begin and then commit must be called on the returned BundleOperation object. If either of these methods throw a BundleException or some other error occurs, then undo must be called on the BundleOperation object to undo the change to persistent storage.

Specified by:

updateBundle in interface FrameworkAdaptor

Parameters:

bundledata - BundleData to update.

source - URLConnection from which the updated bundle may be read. Any InputStreams returned from the source (URLConnections.getInputStream) must be closed by the BundleOperation object.

Returns:

BundleOperation object to be used to complete the update.

See Also:

FrameworkAdaptor.updateBundle(BundleData, URLConnection)

uninstallBundle

public BundleOperation uninstallBundle(BundleData bundledata)

Description copied from interface: FrameworkAdaptor

Prepare to uninstall a bundle.

To complete the uninstall, begin and then commit must be called on the returned BundleOperation object. If either of these methods throw a BundleException or some other error occurs, then undo must be called on the BundleOperation object to undo the change to persistent storage.

Specified by:

uninstallBundle in interface FrameworkAdaptor

Parameters:

bundledata - BundleData to uninstall.

Returns:

BundleOperation object to be used to complete the uninstall.

See Also:

FrameworkAdaptor.uninstallBundle(BundleData)

getTotalFreeSpace

public long getTotalFreeSpace()
                       throws IOException

Description copied from interface: FrameworkAdaptor

Returns the total amount of free space available for bundle storage on the device.

Specified by:

getTotalFreeSpace in interface FrameworkAdaptor

Returns:

Free space available in bytes or -1 if it does not apply to this adaptor

Throws:

IOException - if an I/O error occurs determining the available space

See Also:

FrameworkAdaptor.getTotalFreeSpace()

getPermissionStorage

public PermissionStorage getPermissionStorage()
                                       throws IOException

Description copied from interface: FrameworkAdaptor

Returns the PermissionStorage object which will be used to to manage the permission data.

Specified by:

getPermissionStorage in interface FrameworkAdaptor

Returns:

The PermissionStorage object for the adaptor.

Throws:

IOException

See Also:

FrameworkAdaptor.getPermissionStorage()

frameworkStart

public void frameworkStart(BundleContext fwContext)
                    throws BundleException

This method calls all the configured adaptor hook AdaptorHook.frameworkStart(BundleContext) methods.

Specified by:

frameworkStart in interface FrameworkAdaptor

Parameters:

fwContext - The System Bundle's BundleContext.

Throws:

BundleException - on any error that may occur.

See Also:

FrameworkAdaptor.frameworkStart(BundleContext)

frameworkStop

public void frameworkStop(BundleContext fwContext)
                   throws BundleException

This method calls all the configured adaptor hook AdaptorHook.frameworkStop(BundleContext) methods.

Specified by:

frameworkStop in interface FrameworkAdaptor

Parameters:

fwContext - The System Bundle's BundleContext.

Throws:

BundleException - on any error that may occur.

See Also:

FrameworkAdaptor.frameworkStop(BundleContext)

frameworkStopping

public void frameworkStopping(BundleContext fwContext)

This method calls all the configured adaptor hook AdaptorHook.frameworkStopping(BundleContext) methods.

Specified by:

frameworkStopping in interface FrameworkAdaptor

Parameters:

fwContext - The System Bundle's BundleContext.

See Also:

FrameworkAdaptor.frameworkStopping(BundleContext)

getInitialBundleStartLevel

public int getInitialBundleStartLevel()

Description copied from interface: FrameworkAdaptor

Returns the initial bundle start level as maintained by this adaptor

Specified by:

getInitialBundleStartLevel in interface FrameworkAdaptor

Returns:

the initial bundle start level

See Also:

FrameworkAdaptor.getInitialBundleStartLevel()

setInitialBundleStartLevel

public void setInitialBundleStartLevel(int value)

Description copied from interface: FrameworkAdaptor

Sets the initial bundle start level

Specified by:

setInitialBundleStartLevel in interface FrameworkAdaptor

Parameters:

value - the initial bundle start level

See Also:

FrameworkAdaptor.setInitialBundleStartLevel(int)

getFrameworkLog

public FrameworkLog getFrameworkLog()

This method calls all configured adaptor hook AdaptorHook.createFrameworkLog() methods until the first one returns a non-null value. If none of the adaptor hooks return a non-null value then a framework log implementation which does nothing is returned.

Specified by:

getFrameworkLog in interface FrameworkAdaptor

Returns:

The FrameworkLog to be used by the Framework.

See Also:

FrameworkAdaptor.getFrameworkLog()

createSystemBundleData

public BundleData createSystemBundleData()
                                  throws BundleException

Description copied from interface: FrameworkAdaptor

Creates a BundleData object for the System Bundle. The BundleData returned will be used to define the System Bundle for the Framework.

Specified by:

createSystemBundleData in interface FrameworkAdaptor

Returns:

the BundleData for the System Bundle.

Throws:

BundleException - if any error occurs while creating the System BundleData.

See Also:

FrameworkAdaptor.createSystemBundleData()

getBundleWatcher

public BundleWatcher getBundleWatcher()

Description copied from interface: FrameworkAdaptor

Returns the bundle watcher for this FrameworkAdaptor.

Specified by:

getBundleWatcher in interface FrameworkAdaptor

Returns:

the bundle watcher for this FrameworkAdaptor.

See Also:

FrameworkAdaptor.getBundleWatcher()

getPlatformAdmin

public PlatformAdmin getPlatformAdmin()

Description copied from interface: FrameworkAdaptor

Returns the PlatformAdmin for this FrameworkAdaptor.

This method will not be called until after FrameworkAdaptor.frameworkStart(BundleContext) is called.

Specified by:

getPlatformAdmin in interface FrameworkAdaptor

Returns:

the PlatformAdmin for this FrameworkAdaptor.

See Also:

FrameworkAdaptor.getPlatformAdmin()

getState

public State getState()

Description copied from interface: FrameworkAdaptor

Returns the State for this FrameworkAdaptor.

This method will not be called until after FrameworkAdaptor.frameworkStart(BundleContext) is called. The State returned is used by the framework to resolve bundle dependencies.

Specified by:

getState in interface FrameworkAdaptor

Returns:

the State for this FrameworkAdaptor.

See Also:

FrameworkAdaptor.getState()

getBundleClassLoaderParent

public ClassLoader getBundleClassLoaderParent()

This method calls all the configured classloading hooks ClassLoadingHook.getBundleClassLoaderParent() methods until one returns a non-null value.

Specified by:

getBundleClassLoaderParent in interface FrameworkAdaptor

Returns:

the parent ClassLoader for all BundleClassLoaders created.

See Also:

FrameworkAdaptor.getBundleClassLoaderParent()

handleRuntimeError

public void handleRuntimeError(Throwable error)

This method calls all the configured adaptor hooks AdaptorHook.handleRuntimeError(Throwable) methods.

Specified by:

handleRuntimeError in interface FrameworkAdaptor

Parameters:

error - The Throwable for the runtime error that is to be handled.

See Also:

FrameworkAdaptor.handleRuntimeError(Throwable)

isStopping

public boolean isStopping()

Returns true if the frameworkStopping(BundleContext) method has been called

Returns:

true if the framework is stopping

getEventPublisher

public EventPublisher getEventPublisher()

Returns the event publisher for this BaseAdaptor

Returns:

the event publisher for this BaseAdaptor

getHookRegistry

public HookRegistry getHookRegistry()

Returns the HookRegistry object for this adaptor.

Returns:

the HookRegistry object for this adaptor.

getContext

public BundleContext getContext()

Returns the system bundle's context

Returns:

the system bundle's context

getBundle

public Bundle getBundle(long id)

Returns the bundle with the specified identifier. This method does not invoke and bundle find hooks and therefore does not allow bundle find hooks to hide a bundle from the caller.

Parameters:

id - The identifier of the bundle to retrieve.

Returns:

A Bundle object or null if the identifier does not match any installed bundle.

createBundleFile

public BundleFile createBundleFile(Object content,
                          BaseData data)
                            throws IOException

Creates a bundle file object for the given content and base data. This method must delegate to each configured bundle file factory BundleFileFactoryHook.createBundleFile(Object, BaseData, boolean) method until one factory returns a non-null value. If no bundle file factory returns a non-null value then the the default behavior will be performed.

If the specified content is null then the base content of the specified bundledata must be found before calling any bundle file factories.

After the bundle file has been created each configured bundle file wrapper factory BundleFileWrapperFactoryHook.wrapBundleFile(BundleFile, Object, BaseData, boolean) method is called to wrap the bundle file.

Parameters:

content - The object which contains the content of a bundle file. A value of null indicates that the storage must find the base content for the specified BaseData.

data - The BaseData associated with the content

Returns:

a BundleFile object.

Throws:

IOException - if an error occured while creating the BundleFile

isReadOnly

public boolean isReadOnly()

Returns true if the persistent storage is read-only

Returns:

true if the persistent storage is read-only

getStorage

protected BaseStorage getStorage()

findEntries

public Enumeration<URL> findEntries(List<BundleData> datas,
                           String path,
                           String filePattern,
                           int options)

Description copied from interface: FrameworkAdaptor

Returns resources entries for the specified bundle datas.

Specified by:

findEntries in interface FrameworkAdaptor

Parameters:

datas - the list of bundle datas to search in

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:

FrameworkAdaptor.findEntries(List, String, String, int)

listEntryPaths

public List<String> listEntryPaths(List<BundleFile> bundleFiles,
                          String path,
                          String filePattern,
                          int options)

Returns the names of resources available from a list of bundle files. No duplicate resource names are returned, each name is unique.

Parameters:

bundleFiles - the list of bundle files to search in

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 names. If no resources are found then the empty list is returned.

See Also:

BundleWiring.listResources(String, String, int)