org.eclipse.osgi.framework.internal.core
Class Framework

java.lang.Object
  org.eclipse.osgi.framework.internal.core.Framework

All Implemented Interfaces:

java.lang.Runnable, EventPublisher, EventDispatcher

public class Framework
extends java.lang.Object
implements EventDispatcher, EventPublisher, java.lang.Runnable

Core OSGi Framework class.

Field Summary

protected boolean	active Has the framework been started
protected FrameworkAdaptor	adaptor FrameworkAdaptor specific functions.
protected static AliasMapper	aliasMapper The AliasMapper used to alias OS Names.
protected static int	BATCHEVENT_BEGIN
protected static int	BATCHEVENT_END
protected java.util.Map	bundleEvent List of BundleContexts for bundle's BundleListeners.
protected static int	BUNDLEEVENT
protected java.util.Map	bundleEventSync List of BundleContexts for bundle's SynchronousBundleListeners.
protected static int	BUNDLEEVENTSYNC
protected BundleRepository	bundles The bundles installed in the framework
boolean	compatibiltyBootDelegation
boolean	contextBootDelegation
protected EventManager	eventManager EventManager for event delivery.
protected java.util.Map	frameworkEvent List of BundleContexts for bundle's FrameworkListeners.
protected static int	FRAMEWORKEVENT
protected java.util.Hashtable	installLock
protected PackageAdminImpl	packageAdmin Package Admin object.
static java.lang.String	PROP_EQUINOX_SECURITY
static java.lang.String	PROP_FRAMEWORK_THREAD
protected java.util.Properties	properties Framework properties object.
static java.lang.String	SECURITY_OSGI
protected SecurityAdmin	securityAdmin PermissionAdmin and ConditionalPermissionAdmin impl.
protected StartLevelManager	startLevelManager Startlevel object.
protected InternalSystemBundle	systemBundle System Bundle object
static java.lang.String	THREAD_NORMAL

Constructor Summary

Framework(FrameworkAdaptor adaptor)
Constructor for the Framework instance.

Method Summary

protected void	checkAdminPermission(Bundle bundle, java.lang.String action) Check for specific AdminPermission (RFC 73)
void	close() This method is called to destory the framework instance.
void	dispatchEvent(java.lang.Object l, java.lang.Object lo, int action, java.lang.Object object) Top level event dispatcher for the framework.
FrameworkAdaptor	getAdaptor()
protected AbstractBundle[]	getAllBundles() Retrieve a list of all installed bundles.
AbstractBundle	getBundle(long id) Retrieve the bundle that has the given unique identifier.
protected AbstractBundle	getBundleByLocation(java.lang.String location) Locate an installed bundle with a given identity.
protected AbstractBundle[]	getBundleBySymbolicName(java.lang.String symbolicName) Locate an installed bundle with a given symbolic name
AbstractBundle	getBundleBySymbolicName(java.lang.String symbolicName, Version version) Retrieve the bundle that has the given symbolic name and version.
protected BundleRepository	getBundles() Retrieve the BundleRepository of all installed bundles.
protected java.io.File	getDataFile(AbstractBundle bundle, java.lang.String filename) Creates a File object for a file in the persistent storage area provided for the bundle by the framework.
ClassLoaderDelegateHook[]	getDelegateHooks()
static java.lang.reflect.Field	getField(java.lang.Class clazz, java.lang.Class type, boolean instance)
PackageAdminImpl	getPackageAdmin()
java.lang.String	getProperty(java.lang.String key) Retrieve the value of the named environment property.
protected java.lang.String	getProperty(java.lang.String key, java.lang.String def) Retrieve the value of the named environment property.
ServiceRegistry	getServiceRegistry()
BundleContextImpl	getSystemBundleContext()
protected void	initialize(FrameworkAdaptor adaptor) Initialize the framework to an unlaunched state.
protected void	initializeProperties(java.util.Properties adaptorProperties) Initialize the System properties by copying properties from the adaptor properties object.
protected AbstractBundle	installBundle(java.lang.String location, java.io.InputStream in) Install a bundle from an InputStream.
protected void	installSecurityManager() This is necessary for running from a JXE, otherwise the SecurityManager is set much later than we would like!
protected AbstractBundle	installWorker(java.lang.String location, java.security.PrivilegedExceptionAction action) Worker method to install a bundle.
protected AbstractBundle	installWorkerPrivileged(java.lang.String location, java.net.URLConnection source, java.security.AccessControlContext callerContext) Worker method to install a bundle.
protected boolean	isActive() This method return the state of the framework.
boolean	isBootDelegationPackage(java.lang.String name)
boolean	isServiceAssignableTo(Bundle registrant, Bundle client, java.lang.String className, java.lang.Class serviceClass) Used by ServiceReferenceImpl for isAssignableTo
void	launch() Start the framework.
ListenerQueue	newListenerQueue()
void	publishBundleEvent(int type, Bundle bundle) Deliver a BundleEvent to SynchronousBundleListeners (synchronous).
void	publishBundleEventPrivileged(BundleEvent event)
void	publishFrameworkEvent(int type, Bundle bundle, java.lang.Throwable throwable) Deliver a FrameworkEvent.
void	publishFrameworkEventPrivileged(FrameworkEvent event)
protected void	resumeBundle(AbstractBundle bundle) Resume a bundle.
void	run()
protected java.lang.Object	setProperty(java.lang.String key, java.lang.String value) Set a system property.
void	shutdown(int eventType) Stop the framework.
protected boolean	suspendBundle(AbstractBundle bundle, boolean lock) Suspend a bundle.
FrameworkEvent	waitForStop(long timeout)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FRAMEWORK_THREAD

public static final java.lang.String PROP_FRAMEWORK_THREAD

See Also:

Constant Field Values

THREAD_NORMAL

public static final java.lang.String THREAD_NORMAL

See Also:

Constant Field Values

PROP_EQUINOX_SECURITY

public static final java.lang.String PROP_EQUINOX_SECURITY

See Also:

Constant Field Values

SECURITY_OSGI

public static final java.lang.String SECURITY_OSGI

See Also:

Constant Field Values

adaptor

protected FrameworkAdaptor adaptor

FrameworkAdaptor specific functions.

properties

protected java.util.Properties properties

Framework properties object. A reference to the System.getProperies() object. The properties from the adaptor will be merged into these properties.

active

protected boolean active

Has the framework been started

bundles

protected BundleRepository bundles

The bundles installed in the framework

packageAdmin

protected PackageAdminImpl packageAdmin

Package Admin object. This object manages the exported packages.

securityAdmin

protected SecurityAdmin securityAdmin

PermissionAdmin and ConditionalPermissionAdmin impl. This object manages the bundle permissions.

startLevelManager

protected StartLevelManager startLevelManager

Startlevel object. This object manages the framework and bundle startlevels

bundleEvent

protected java.util.Map bundleEvent

List of BundleContexts for bundle's BundleListeners.

BUNDLEEVENT

protected static final int BUNDLEEVENT

See Also:

Constant Field Values

bundleEventSync

protected java.util.Map bundleEventSync

List of BundleContexts for bundle's SynchronousBundleListeners.

BUNDLEEVENTSYNC

protected static final int BUNDLEEVENTSYNC

See Also:

Constant Field Values

frameworkEvent

protected java.util.Map frameworkEvent

List of BundleContexts for bundle's FrameworkListeners.

FRAMEWORKEVENT

protected static final int FRAMEWORKEVENT

See Also:

Constant Field Values

BATCHEVENT_BEGIN

protected static final int BATCHEVENT_BEGIN

See Also:

Constant Field Values

BATCHEVENT_END

protected static final int BATCHEVENT_END

See Also:

Constant Field Values

eventManager

protected EventManager eventManager

EventManager for event delivery.

installLock

protected java.util.Hashtable installLock

systemBundle

protected InternalSystemBundle systemBundle

System Bundle object

contextBootDelegation

public final boolean contextBootDelegation

compatibiltyBootDelegation

public final boolean compatibiltyBootDelegation

aliasMapper

protected static AliasMapper aliasMapper

The AliasMapper used to alias OS Names.

Constructor Detail

Framework

public Framework(FrameworkAdaptor adaptor)

Constructor for the Framework instance. This method initializes the framework to an unlaunched state.

Method Detail

initialize

protected void initialize(FrameworkAdaptor adaptor)

Initialize the framework to an unlaunched state. This method is called by the Framework constructor.

getAdaptor

public FrameworkAdaptor getAdaptor()

getDelegateHooks

public ClassLoaderDelegateHook[] getDelegateHooks()

getServiceRegistry

public ServiceRegistry getServiceRegistry()

initializeProperties

protected void initializeProperties(java.util.Properties adaptorProperties)

Initialize the System properties by copying properties from the adaptor properties object. This method is called by the initialize method.

isActive

protected boolean isActive()

This method return the state of the framework.

close

public void close()

This method is called to destory the framework instance.

launch

public void launch()

Start the framework. When the framework is started. The following actions occur: 1. Event handling is enabled. Events can now be delivered to listeners. 2. All bundles which are recorded as started are started as described in the Bundle.start() method. These bundles are the bundles that were started when the framework was last stopped. Reports any exceptions that occur during startup using FrameworkEvents. 3. A FrameworkEvent of type FrameworkEvent.STARTED is broadcast.

shutdown

public void shutdown(int eventType)

Stop the framework. When the framework is stopped. The following actions occur: 1. Suspend all started bundles as described in the Bundle.stop method except that the bundle is recorded as started. These bundles will be restarted when the framework is next started. Reports any exceptions that occur during stopping using FrameworkEvents. 2. Event handling is disabled.

getProperty

public java.lang.String getProperty(java.lang.String key)

Retrieve the value of the named environment property. Values are provided for the following properties:

org.osgi.framework.version

The version of the framework.

org.osgi.framework.vendor

The vendor of this framework implementation.

org.osgi.framework.language

The language being used. See ISO 639 for possible values.

org.osgi.framework.os.name

The name of the operating system of the hosting computer.

org.osgi.framework.os.version

The version number of the operating system of the hosting computer.

org.osgi.framework.processor

The name of the processor of the hosting computer.

Note: These last four properties are used by the Bundle-NativeCode manifest header's matching algorithm for selecting native code.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property, or null if the property is undefined.

getProperty

protected java.lang.String getProperty(java.lang.String key,
                                       java.lang.String def)

Retrieve the value of the named environment property. Values are provided for the following properties:

org.osgi.framework.version

The version of the framework.

org.osgi.framework.vendor

The vendor of this framework implementation.

org.osgi.framework.language

The language being used. See ISO 639 for possible values.

org.osgi.framework.os.name

The name of the operating system of the hosting computer.

org.osgi.framework.os.version

The version number of the operating system of the hosting computer.

org.osgi.framework.processor

The name of the processor of the hosting computer.

Note: These last four properties are used by the Bundle-NativeCode manifest header's matching algorithm for selecting native code.

Parameters:

key - The name of the requested property.

def - A default value is the requested property is not present.

Returns:

The value of the requested property, or the default value if the property is undefined.

setProperty

protected java.lang.Object setProperty(java.lang.String key,
                                       java.lang.String value)

Set a system property.

Parameters:

key - The name of the property to set.

value - The value to set.

Returns:

The previous value of the property or null if the property was not previously set.

installBundle

protected AbstractBundle installBundle(java.lang.String location,
                                       java.io.InputStream in)
                                throws BundleException

Install a bundle from an InputStream.

Parameters:

location - The location identifier of the bundle to install.

in - The InputStream from which the bundle will be read. If null then the location is used to get the bundle content.

Returns:

The Bundle of the installed bundle.

Throws:

BundleException

installWorker

protected AbstractBundle installWorker(java.lang.String location,
                                       java.security.PrivilegedExceptionAction action)
                                throws BundleException

Worker method to install a bundle. It obtains the reservation for the location and calls the specified action.

Parameters:

location - The location identifier of the bundle to install.

action - A PrivilegedExceptionAction which calls the real worker.

Returns:

The AbstractBundleof the installed bundle.

Throws:

BundleException - If the action throws an error.

installWorkerPrivileged

protected AbstractBundle installWorkerPrivileged(java.lang.String location,
                                                 java.net.URLConnection source,
                                                 java.security.AccessControlContext callerContext)
                                          throws BundleException

Worker method to install a bundle. It calls the FrameworkAdaptor object to install the bundle in persistent storage.

Parameters:

location - The location identifier of the bundle to install.

source - The URLConnection from which the bundle will be read.

Returns:

The AbstractBundleof the installed bundle.

Throws:

BundleException - If the provided stream cannot be read.

getBundle

public AbstractBundle getBundle(long id)

Retrieve the bundle that has the given unique identifier.

Parameters:

id - The identifier of the bundle to retrieve.

Returns:

A AbstractBundleobject, or null if the identifier doesn't match any installed bundle.

getSystemBundleContext

public BundleContextImpl getSystemBundleContext()

getPackageAdmin

public PackageAdminImpl getPackageAdmin()

getBundleBySymbolicName

public AbstractBundle getBundleBySymbolicName(java.lang.String symbolicName,
                                              Version version)

Retrieve the bundle that has the given symbolic name and version.

Parameters:

symbolicName - The symbolic name of the bundle to retrieve

version - The version of the bundle to retrieve

Returns:

A AbstractBundleobject, or null if the identifier doesn't match any installed bundle.

getBundles

protected BundleRepository getBundles()

Retrieve the BundleRepository of all installed bundles. The list is valid at the time of the call to getBundles, but the framework is a very dynamic environment and bundles can be installed or uninstalled at anytime.

Returns:

The BundleRepository.

getAllBundles

protected AbstractBundle[] getAllBundles()

Retrieve a list of all installed bundles. The list is valid at the time of the call to getBundleAlls, but the framework is a very dynamic environment and bundles can be installed or uninstalled at anytime.

Returns:

An Array of AbstractBundleobjects, one object per installed bundle.

resumeBundle

protected void resumeBundle(AbstractBundle bundle)

Resume a bundle.

Parameters:

bundle - Bundle to resume.

suspendBundle

protected boolean suspendBundle(AbstractBundle bundle,
                                boolean lock)

Suspend a bundle.

Parameters:

bundle - Bundle to suspend.

lock - true if state change lock should be held when returning from this method.

Returns:

true if bundle was active and is now suspended.

getBundleByLocation

protected AbstractBundle getBundleByLocation(java.lang.String location)

Locate an installed bundle with a given identity.

Parameters:

location - string for the bundle

Returns:

Bundle object for bundle with the specified location or null if no bundle is installed with the specified location.

getBundleBySymbolicName

protected AbstractBundle[] getBundleBySymbolicName(java.lang.String symbolicName)

Locate an installed bundle with a given symbolic name

Parameters:

symbolicName - The symbolic name for the bundle

Returns:

Bundle object for bundle with the specified Unique or null if no bundle is installed with the specified location.

getDataFile

protected java.io.File getDataFile(AbstractBundle bundle,
                                   java.lang.String filename)

Creates a File object for a file in the persistent storage area provided for the bundle by the framework. If the adaptor does not have file system support, this method will return null.

A File object for the base directory of the persistent storage area provided for the context bundle by the framework can be obtained by calling this method with the empty string ("") as the parameter.

checkAdminPermission

protected void checkAdminPermission(Bundle bundle,
                                    java.lang.String action)

Check for specific AdminPermission (RFC 73)

installSecurityManager

protected void installSecurityManager()

This is necessary for running from a JXE, otherwise the SecurityManager is set much later than we would like!

publishFrameworkEvent

public void publishFrameworkEvent(int type,
                                  Bundle bundle,
                                  java.lang.Throwable throwable)

Deliver a FrameworkEvent.

Specified by:

publishFrameworkEvent in interface EventPublisher

Parameters:

type - FrameworkEvent type.

bundle - Affected bundle or null for system bundle.

throwable - Related exception or null.

See Also:

FrameworkEvent

publishFrameworkEventPrivileged

public void publishFrameworkEventPrivileged(FrameworkEvent event)

publishBundleEvent

public void publishBundleEvent(int type,
                               Bundle bundle)

Deliver a BundleEvent to SynchronousBundleListeners (synchronous). and BundleListeners (asynchronous).

Parameters:

type - BundleEvent type.

bundle - Affected bundle or null.

publishBundleEventPrivileged

public void publishBundleEventPrivileged(BundleEvent event)

newListenerQueue

public ListenerQueue newListenerQueue()

dispatchEvent

public void dispatchEvent(java.lang.Object l,
                          java.lang.Object lo,
                          int action,
                          java.lang.Object object)

Top level event dispatcher for the framework.

Specified by:

dispatchEvent in interface EventDispatcher

Parameters:

l - BundleContext for receiving bundle

lo - BundleContext for receiving bundle

action - Event class type

object - ListenerQueue to populate

getField

public static java.lang.reflect.Field getField(java.lang.Class clazz,
                                               java.lang.Class type,
                                               boolean instance)

run

public void run()

Specified by:

run in interface java.lang.Runnable

waitForStop

public FrameworkEvent waitForStop(long timeout)
                           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

isServiceAssignableTo

public boolean isServiceAssignableTo(Bundle registrant,
                                     Bundle client,
                                     java.lang.String className,
                                     java.lang.Class serviceClass)

Used by ServiceReferenceImpl for isAssignableTo

Parameters:

registrant - Bundle registering service

client - Bundle desiring to use service

className - class name to use

serviceClass - class of original service object

Returns:

true if assignable given package wiring

isBootDelegationPackage

public boolean isBootDelegationPackage(java.lang.String name)