org.osgi.core 6.0.0 · org.osgi.framework.wiring.FrameworkWiring

Method Summary

Modifier and Type	Method and Description
public Collection<BundleCapability>	Returns: A collection of `BundleCapability` objects that match the specified requirement. findProviders(Requirement The requirement to find matching bundle capabilities. Must not be `null`. requirement) Find bundle capabilities that match the given requirement.
public Collection<Bundle>	Returns: A collection containing a snapshot of the dependency closure of the specified bundles, or an empty collection if there were no specified bundles. getDependencyClosure(Collection<Bundle> The initial bundles for which to generate the dependency closure. bundles) Returns the dependency closure for the specified bundles.
public Collection<Bundle>	Returns: A collection containing a snapshot of the `Bundle`s which have non-current, in use `BundleWiring`s, or an empty collection if there are no such bundles. getRemovalPendingBundles() Returns the bundles that have `non-current`, `in use` bundle wirings.
public void	refreshBundles(Collection<Bundle> The bundles to be refreshed, or `null` to refresh the `removal pending` bundles. bundles, FrameworkListener... Zero or more listeners to be notified when the bundle refresh has been completed. The specified listeners do not need to be otherwise registered with the framework. If a specified listener is already registered with the framework, it will be notified twice. listeners) Refreshes the specified bundles.
public boolean	Returns: `true` if all specified bundles are resolved; `false` otherwise. resolveBundles(Collection<Bundle> The bundles to resolve or `null` to resolve all unresolved bundles installed in the Framework. bundles) Resolves the specified bundles.

Inherited from org.osgi.framework.BundleReference:: getBundle

Method Detail

findProviders back to summary

findProviders	back to summary
public Collection<BundleCapability> findProviders(Requirement requirement) Find bundle capabilities that match the given requirement. The returned collection contains `BundleCapability` objects where the revision must be the `declaring revision` of the capability and the revision must either be the current bundle revision or an `in use` bundle revision. Each returned capability must match the given requirement. This means that the filter in the requirement must match as well as any namespace specific directives. For example, the mandatory attributes for the osgi.wiring.package namespace. The returned collection has not been filtered to remove capabilities that are non-effective, substituted or for which the providing bundle does not have permission to provide. No resolve hooks are called to filter matching capabilities. Parameters requirement:Requirement The requirement to find matching bundle capabilities. Must not be `null`. Returns:Collection<BundleCapability> A collection of `BundleCapability` objects that match the specified requirement. Since 1.2

public Collection<BundleCapability> findProviders(Requirement requirement)

Find bundle capabilities that match the given requirement.

The returned collection contains BundleCapability objects where the revision must be the declaring revision of the capability and the revision must either be the current bundle revision or an in use bundle revision.

Each returned capability must match the given requirement. This means that the filter in the requirement must match as well as any namespace specific directives. For example, the mandatory attributes for the osgi.wiring.package namespace.

The returned collection has not been filtered to remove capabilities that are non-effective, substituted or for which the providing bundle does not have permission to provide. No resolve hooks are called to filter matching capabilities.

Parameters

requirement:Requirement: The requirement to find matching bundle capabilities. Must not be null.

Returns:Collection<BundleCapability>

A collection of BundleCapability objects that match the specified requirement.

Since

1.2

getDependencyClosure back to summary

getDependencyClosure	back to summary
public Collection<Bundle> getDependencyClosure(Collection<Bundle> bundles) Returns the dependency closure for the specified bundles. A graph of bundles is computed starting with the specified bundles. The graph is expanded by adding any bundle that is either wired to a package that is currently exported by a bundle in the graph or requires a bundle in the graph. The graph is fully constructed when there is no bundle outside the graph that is wired to a bundle in the graph. The graph may contain `UNINSTALLED` bundles that are `removal pending`. Parameters bundles:Collection<Bundle> The initial bundles for which to generate the dependency closure. Returns:Collection<Bundle> A collection containing a snapshot of the dependency closure of the specified bundles, or an empty collection if there were no specified bundles. Exceptions IllegalArgumentException: If the specified `Bundle`s were not created by the same framework instance associated with this FrameworkWiring.

public Collection<Bundle> getDependencyClosure(Collection<Bundle> bundles)

Returns the dependency closure for the specified bundles.

A graph of bundles is computed starting with the specified bundles. The graph is expanded by adding any bundle that is either wired to a package that is currently exported by a bundle in the graph or requires a bundle in the graph. The graph is fully constructed when there is no bundle outside the graph that is wired to a bundle in the graph. The graph may contain UNINSTALLED bundles that are removal pending.

Parameters

bundles:Collection<Bundle>: The initial bundles for which to generate the dependency closure.

Returns:Collection<Bundle>

A collection containing a snapshot of the dependency closure of the specified bundles, or an empty collection if there were no specified bundles.

Exceptions

IllegalArgumentException:: If the specified Bundles were not created by the same framework instance associated with this FrameworkWiring.

getRemovalPendingBundles back to summary

getRemovalPendingBundles	back to summary
public Collection<Bundle> getRemovalPendingBundles() Returns the bundles that have `non-current`, `in use` bundle wirings. This is typically the bundles which have been updated or uninstalled since the last call to `refreshBundles(Collection, FrameworkListener...)`. Returns:Collection<Bundle> A collection containing a snapshot of the `Bundle`s which have non-current, in use `BundleWiring`s, or an empty collection if there are no such bundles.

public Collection<Bundle> getRemovalPendingBundles()

Returns the bundles that have non-current, in use bundle wirings. This is typically the bundles which have been updated or uninstalled since the last call to refreshBundles(Collection, FrameworkListener...).

Returns:Collection<Bundle>: A collection containing a snapshot of the Bundles which have non-current, in use BundleWirings, or an empty collection if there are no such bundles.

refreshBundles back to summary

refreshBundles	back to summary
public void refreshBundles(Collection<Bundle> bundles, FrameworkListener... listeners) Refreshes the specified bundles. This forces the update (replacement) or removal of packages exported by the specified bundles. The technique by which the framework refreshes bundles may vary among different framework implementations. A permissible implementation is to stop and restart the framework. This method returns to the caller immediately and then performs the following steps on a separate thread: Compute the `dependency closure` of the specified bundles. If no bundles are specified, compute the dependency closure of the `removal pending` bundles. Each bundle in the dependency closure that is in the `ACTIVE` state will be stopped as described in the `Bundle.stop` method. Each bundle in the dependency closure that is in the `RESOLVED` state is unresolved and thus moved to the `INSTALLED` state. The effect of this step is that bundles in the dependency closure are no longer `RESOLVED`. Each bundle in the dependency closure that is in the `UNINSTALLED` state is removed from the dependency closure and is now completely removed from the Framework. Each bundle in the dependency closure that was in the `ACTIVE` state prior to Step 2 is started as described in the `Bundle.start` method, causing all bundles required for the restart to be resolved. It is possible that, as a result of the previous steps, packages that were previously exported no longer are. Therefore, some bundles may be unresolvable until bundles satisfying the dependencies have been installed in the Framework. For any exceptions that are thrown during any of these steps, a framework event of type `FrameworkEvent.ERROR` is fired containing the exception. The source bundle for these events should be the specific bundle to which the exception is related. If no specific bundle can be associated with the exception then the System Bundle must be used as the source bundle for the event. All framework events fired by this method are also delivered to the specified `FrameworkListener`s in the order they are specified. When this process completes after the bundles are refreshed, the Framework will fire a Framework event of type `FrameworkEvent.PACKAGES_REFRESHED` to announce it has completed the bundle refresh. The specified `FrameworkListener`s are notified in the order specified. Each specified `FrameworkListener` will be called with a Framework event of type `FrameworkEvent.PACKAGES_REFRESHED`. Parameters bundles:Collection<Bundle> The bundles to be refreshed, or `null` to refresh the `removal pending` bundles. listeners:FrameworkListener[] Zero or more listeners to be notified when the bundle refresh has been completed. The specified listeners do not need to be otherwise registered with the framework. If a specified listener is already registered with the framework, it will be notified twice. Exceptions IllegalArgumentException: If the specified `Bundle`s were not created by the same framework instance associated with this FrameworkWiring. SecurityException: If the caller does not have `AdminPermission[System Bundle,RESOLVE]` and the Java runtime environment supports permissions.

public void refreshBundles(Collection<Bundle> bundles, FrameworkListener... listeners)

Refreshes the specified bundles. This forces the update (replacement) or removal of packages exported by the specified bundles.

The technique by which the framework refreshes bundles may vary among different framework implementations. A permissible implementation is to stop and restart the framework.

This method returns to the caller immediately and then performs the following steps on a separate thread:

Compute the dependency closure of the specified bundles. If no bundles are specified, compute the dependency closure of the removal pending bundles.
Each bundle in the dependency closure that is in the ACTIVE state will be stopped as described in the Bundle.stop method.
Each bundle in the dependency closure that is in the RESOLVED state is unresolved and thus moved to the INSTALLED state. The effect of this step is that bundles in the dependency closure are no longer RESOLVED.
Each bundle in the dependency closure that is in the UNINSTALLED state is removed from the dependency closure and is now completely removed from the Framework.
Each bundle in the dependency closure that was in the ACTIVE state prior to Step 2 is started as described in the Bundle.start method, causing all bundles required for the restart to be resolved. It is possible that, as a result of the previous steps, packages that were previously exported no longer are. Therefore, some bundles may be unresolvable until bundles satisfying the dependencies have been installed in the Framework.

For any exceptions that are thrown during any of these steps, a framework event of type FrameworkEvent.ERROR is fired containing the exception. The source bundle for these events should be the specific bundle to which the exception is related. If no specific bundle can be associated with the exception then the System Bundle must be used as the source bundle for the event. All framework events fired by this method are also delivered to the specified FrameworkListeners in the order they are specified.

When this process completes after the bundles are refreshed, the Framework will fire a Framework event of type FrameworkEvent.PACKAGES_REFRESHED to announce it has completed the bundle refresh. The specified FrameworkListeners are notified in the order specified. Each specified FrameworkListener will be called with a Framework event of type FrameworkEvent.PACKAGES_REFRESHED.

Parameters

bundles:Collection<Bundle>: The bundles to be refreshed, or null to refresh the removal pending bundles.
listeners:FrameworkListener[]: Zero or more listeners to be notified when the bundle refresh has been completed. The specified listeners do not need to be otherwise registered with the framework. If a specified listener is already registered with the framework, it will be notified twice.

Exceptions

IllegalArgumentException:: If the specified Bundles were not created by the same framework instance associated with this FrameworkWiring.
SecurityException:: If the caller does not have AdminPermission[System Bundle,RESOLVE] and the Java runtime environment supports permissions.

resolveBundles back to summary

resolveBundles	back to summary
public boolean resolveBundles(Collection<Bundle> bundles) Resolves the specified bundles. The Framework must attempt to resolve the specified bundles that are unresolved. Additional bundles that are not included in the specified bundles may be resolved as a result of calling this method. A permissible implementation of this method is to attempt to resolve all unresolved bundles installed in the framework. If no bundles are specified, then the Framework will attempt to resolve all unresolved bundles. This method must not cause any bundle to be refreshed, stopped, or started. This method will not return until the operation has completed. Parameters bundles:Collection<Bundle> The bundles to resolve or `null` to resolve all unresolved bundles installed in the Framework. Returns:boolean `true` if all specified bundles are resolved; `false` otherwise. Exceptions IllegalArgumentException: If the specified `Bundle`s were not created by the same framework instance associated with this FrameworkWiring. SecurityException: If the caller does not have `AdminPermission[System Bundle,RESOLVE]` and the Java runtime environment supports permissions.

public boolean resolveBundles(Collection<Bundle> bundles)

Resolves the specified bundles. The Framework must attempt to resolve the specified bundles that are unresolved. Additional bundles that are not included in the specified bundles may be resolved as a result of calling this method. A permissible implementation of this method is to attempt to resolve all unresolved bundles installed in the framework.

If no bundles are specified, then the Framework will attempt to resolve all unresolved bundles. This method must not cause any bundle to be refreshed, stopped, or started. This method will not return until the operation has completed.

Parameters

bundles:Collection<Bundle>: The bundles to resolve or null to resolve all unresolved bundles installed in the Framework.

Returns:boolean

true if all specified bundles are resolved; false otherwise.

Exceptions

IllegalArgumentException:: If the specified Bundles were not created by the same framework instance associated with this FrameworkWiring.
SecurityException:: If the caller does not have AdminPermission[System Bundle,RESOLVE] and the Java runtime environment supports permissions.

public Interface FrameworkWiring

Method Summary

Method Detail