OSGi 8.1.0 · org.osgi.service.packageadmin.PackageAdmin

Modifier and Type	Field and Description
public static final int	BUNDLE_TYPE_FRAGMENT Bundle type indicating the bundle is a fragment bundle.

Method Summary

Modifier and Type	Method and Description
public Bundle	Returns: The bundle from which the specified class is loaded or `null` if the class was not loaded by a bundle class loader created by the same framework instance that registered this `PackageAdmin` service. getBundle(Class<?> The class object from which to locate the bundle. clazz) Returns the bundle from which the specified class is loaded.
public Bundle[]	Returns: An array of bundles with the specified name belonging to the specified version range ordered in descending version order, or `null` if no bundles are found. getBundles(String The symbolic name of the desired bundles. symbolicName, String The version range of the desired bundles, or `null` if all versions are desired. versionRange) Returns the bundles with the specified symbolic name whose bundle version is within the specified version range.
public int	Returns: The special type of the bundle. getBundleType(Bundle The bundle for which to return the special type. bundle) Returns the special type of the specified bundle.
public ExportedPackage	Returns: The exported package, or `null` if no exported package with the specified name exists. getExportedPackage(String The name of the exported package to be returned. name) Deprecated Gets the exported package for the specified package name.
public ExportedPackage[]	Returns: An array of exported packages, or `null` if the specified bundle has no exported packages. getExportedPackages(Bundle The bundle whose exported packages are to be returned, or `null` if all exported packages are to be returned. If the specified bundle is the system bundle (that is, the bundle with id zero), this method returns all the packages known to be exported by the system bundle. This will include the package specified by the `org.osgi.framework.system.packages` system property as well as any other package exported by the framework implementation. bundle) Deprecated Gets the exported packages for the specified bundle.
public ExportedPackage[]	Returns: An array of the exported packages, or `null` if no exported packages with the specified name exists. getExportedPackages(String The name of the exported packages to be returned. name) Deprecated Gets the exported packages for the specified package name.
public Bundle[]	Returns: An array of fragment bundles or `null` if the bundle does not have any attached fragment bundles or the bundle is not resolved. getFragments(Bundle The bundle whose attached fragment bundles are to be returned. bundle) Returns an array of attached fragment bundles for the specified bundle.
public Bundle[]	Returns: An array containing the host bundles to which the specified fragment is attached or `null` if the specified bundle is not a fragment or is not attached to any host bundles. getHosts(Bundle The fragment bundle whose host bundles are to be returned. bundle) Returns the host bundles to which the specified fragment bundle is attached.
public RequiredBundle[]	Returns: An array of required bundles or `null` if no required bundles exist for the specified symbolic name. getRequiredBundles(String The bundle symbolic name or `null` for all required bundles. symbolicName) Deprecated Returns an array of required bundles having the specified symbolic name.
public void	refreshPackages(Bundle[] The bundles whose exported packages are to be updated or removed, or `null` for all bundles updated or uninstalled since the last call to this method. bundles) Forces the update (replacement) or removal of packages exported by the specified bundles.
public boolean	Returns: `true` if all specified bundles are resolved; resolveBundles(Bundle[] The bundles to resolve or `null` to resolve all unresolved bundles installed in the Framework. bundles) Resolve the specified bundles.

BUNDLE_TYPE_FRAGMENT	back to summary
public static final int BUNDLE_TYPE_FRAGMENT Bundle type indicating the bundle is a fragment bundle. The value of `BUNDLE_TYPE_FRAGMENT` is 0x00000001. Since 1.2

Method Detail

getBundle back to summary

getBundle	back to summary
public Bundle getBundle(Class<?> clazz) Returns the bundle from which the specified class is loaded. The class loader of the returned bundle must have been used to load the specified class. If the class was not loaded by a bundle class loader then `null` is returned. Parameters clazz:Class<?> The class object from which to locate the bundle. Returns:Bundle The bundle from which the specified class is loaded or `null` if the class was not loaded by a bundle class loader created by the same framework instance that registered this `PackageAdmin` service. Since 1.2

public Bundle getBundle(Class<?> clazz)

Returns the bundle from which the specified class is loaded. The class loader of the returned bundle must have been used to load the specified class. If the class was not loaded by a bundle class loader then null is returned.

Parameters

clazz:Class<?>: The class object from which to locate the bundle.

Returns:Bundle

The bundle from which the specified class is loaded or null if the class was not loaded by a bundle class loader created by the same framework instance that registered this PackageAdmin service.

Since

1.2

getBundles back to summary

getBundles	back to summary
public Bundle[] getBundles(String symbolicName, String versionRange) Returns the bundles with the specified symbolic name whose bundle version is within the specified version range. If no bundles are installed that have the specified symbolic name, then `null` is returned. If a version range is specified, then only the bundles that have the specified symbolic name and whose bundle versions belong to the specified version range are returned. The returned bundles are ordered by version in descending version order so that the first element of the array contains the bundle with the highest version. Parameters symbolicName:String The symbolic name of the desired bundles. versionRange:String The version range of the desired bundles, or `null` if all versions are desired. Returns:Bundle[] An array of bundles with the specified name belonging to the specified version range ordered in descending version order, or `null` if no bundles are found. Since 1.2 See Also `org.osgi.framework.Constants#BUNDLE_VERSION_ATTRIBUTE`

public Bundle[] getBundles(String symbolicName, String versionRange)

Returns the bundles with the specified symbolic name whose bundle version is within the specified version range. If no bundles are installed that have the specified symbolic name, then null is returned. If a version range is specified, then only the bundles that have the specified symbolic name and whose bundle versions belong to the specified version range are returned. The returned bundles are ordered by version in descending version order so that the first element of the array contains the bundle with the highest version.

Parameters

symbolicName:String: The symbolic name of the desired bundles.
versionRange:String: The version range of the desired bundles, or null if all versions are desired.

Returns:Bundle[]

An array of bundles with the specified name belonging to the specified version range ordered in descending version order, or null if no bundles are found.

Since

1.2

getBundleType back to summary

getBundleType	back to summary
public int getBundleType(Bundle bundle) Returns the special type of the specified bundle. The bundle type values are: `BUNDLE_TYPE_FRAGMENT` A bundle may be more than one type at a time. A type code is used to identify the bundle type for future extendability. If a bundle is not one or more of the defined types then 0x00000000 is returned. Parameters bundle:Bundle The bundle for which to return the special type. Returns:int The special type of the bundle. Exceptions IllegalArgumentException: If the specified `Bundle` was not created by the same framework instance that registered this `PackageAdmin` service. Since 1.2

public int getBundleType(Bundle bundle)

Returns the special type of the specified bundle. The bundle type values are:

BUNDLE_TYPE_FRAGMENT

A bundle may be more than one type at a time. A type code is used to identify the bundle type for future extendability.

If a bundle is not one or more of the defined types then 0x00000000 is returned.

Parameters

bundle:Bundle: The bundle for which to return the special type.

Returns:int

The special type of the bundle.

Exceptions

IllegalArgumentException:: If the specified Bundle was not created by the same framework instance that registered this PackageAdmin service.

Since

1.2

getExportedPackage back to summary

getExportedPackage	back to summary
public ExportedPackage getExportedPackage(String name) Deprecated Gets the exported package for the specified package name. If there are multiple exported packages with specified name, the exported package with the highest version will be returned. Parameters name:String The name of the exported package to be returned. Returns:ExportedPackage The exported package, or `null` if no exported package with the specified name exists. See Also `getExportedPackages(String)`

public ExportedPackage getExportedPackage(String name)

Deprecated

Gets the exported package for the specified package name.

If there are multiple exported packages with specified name, the exported package with the highest version will be returned.

Parameters

name:String: The name of the exported package to be returned.

Returns:ExportedPackage

The exported package, or null if no exported package with the specified name exists.

See Also

getExportedPackages(String)

getExportedPackages back to summary

getExportedPackages	back to summary
public ExportedPackage[] getExportedPackages(Bundle bundle) Deprecated Gets the exported packages for the specified bundle. Parameters bundle:Bundle The bundle whose exported packages are to be returned, or `null` if all exported packages are to be returned. If the specified bundle is the system bundle (that is, the bundle with id zero), this method returns all the packages known to be exported by the system bundle. This will include the package specified by the `org.osgi.framework.system.packages` system property as well as any other package exported by the framework implementation. Returns:ExportedPackage[] An array of exported packages, or `null` if the specified bundle has no exported packages. Exceptions IllegalArgumentException: If the specified `Bundle` was not created by the same framework instance that registered this `PackageAdmin` service.

public ExportedPackage[] getExportedPackages(Bundle bundle)

Deprecated

Gets the exported packages for the specified bundle.

Parameters

bundle:Bundle: The bundle whose exported packages are to be returned, or null if all exported packages are to be returned. If the specified bundle is the system bundle (that is, the bundle with id zero), this method returns all the packages known to be exported by the system bundle. This will include the package specified by the org.osgi.framework.system.packages system property as well as any other package exported by the framework implementation.

Returns:ExportedPackage[]

An array of exported packages, or null if the specified bundle has no exported packages.

Exceptions

IllegalArgumentException:: If the specified Bundle was not created by the same framework instance that registered this PackageAdmin service.

getExportedPackages back to summary

getExportedPackages	back to summary
public ExportedPackage[] getExportedPackages(String name) Deprecated Gets the exported packages for the specified package name. Parameters name:String The name of the exported packages to be returned. Returns:ExportedPackage[] An array of the exported packages, or `null` if no exported packages with the specified name exists. Since 1.2

public ExportedPackage[] getExportedPackages(String name)

Deprecated

Gets the exported packages for the specified package name.

Parameters

name:String: The name of the exported packages to be returned.

Returns:ExportedPackage[]

An array of the exported packages, or null if no exported packages with the specified name exists.

Since

1.2

getFragments back to summary

getFragments	back to summary
public Bundle[] getFragments(Bundle bundle) Returns an array of attached fragment bundles for the specified bundle. If the specified bundle is a fragment then `null` is returned. If no fragments are attached to the specified bundle then `null` is returned. This method does not attempt to resolve the specified bundle. If the specified bundle is not resolved then `null` is returned. Parameters bundle:Bundle The bundle whose attached fragment bundles are to be returned. Returns:Bundle[] An array of fragment bundles or `null` if the bundle does not have any attached fragment bundles or the bundle is not resolved. Exceptions IllegalArgumentException: If the specified `Bundle` was not created by the same framework instance that registered this `PackageAdmin` service. Since 1.2

public Bundle[] getFragments(Bundle bundle)

Returns an array of attached fragment bundles for the specified bundle. If the specified bundle is a fragment then null is returned. If no fragments are attached to the specified bundle then null is returned.

This method does not attempt to resolve the specified bundle. If the specified bundle is not resolved then null is returned.

Parameters

bundle:Bundle: The bundle whose attached fragment bundles are to be returned.

Returns:Bundle[]

An array of fragment bundles or null if the bundle does not have any attached fragment bundles or the bundle is not resolved.

Exceptions

IllegalArgumentException:: If the specified Bundle was not created by the same framework instance that registered this PackageAdmin service.

Since

1.2

getHosts back to summary

getHosts	back to summary
public Bundle[] getHosts(Bundle bundle) Returns the host bundles to which the specified fragment bundle is attached. Parameters bundle:Bundle The fragment bundle whose host bundles are to be returned. Returns:Bundle[] An array containing the host bundles to which the specified fragment is attached or `null` if the specified bundle is not a fragment or is not attached to any host bundles. Exceptions IllegalArgumentException: If the specified `Bundle` was not created by the same framework instance that registered this `PackageAdmin` service. Since 1.2

public Bundle[] getHosts(Bundle bundle)

Returns the host bundles to which the specified fragment bundle is attached.

Parameters

bundle:Bundle: The fragment bundle whose host bundles are to be returned.

Returns:Bundle[]

An array containing the host bundles to which the specified fragment is attached or null if the specified bundle is not a fragment or is not attached to any host bundles.

Exceptions

IllegalArgumentException:: If the specified Bundle was not created by the same framework instance that registered this PackageAdmin service.

Since

1.2

getRequiredBundles back to summary

getRequiredBundles	back to summary
public RequiredBundle[] getRequiredBundles(String symbolicName) Deprecated Returns an array of required bundles having the specified symbolic name. If `null` is specified, then all required bundles will be returned. Parameters symbolicName:String The bundle symbolic name or `null` for all required bundles. Returns:RequiredBundle[] An array of required bundles or `null` if no required bundles exist for the specified symbolic name. Since 1.2

public RequiredBundle[] getRequiredBundles(String symbolicName)

Deprecated

Returns an array of required bundles having the specified symbolic name.

If null is specified, then all required bundles will be returned.

Parameters

symbolicName:String: The bundle symbolic name or null for all required bundles.

Returns:RequiredBundle[]

An array of required bundles or null if no required bundles exist for the specified symbolic name.

Since

1.2

refreshPackages back to summary

refreshPackages	back to summary
public void refreshPackages(Bundle[] bundles) Forces the update (replacement) or removal of packages exported by the specified bundles. If no bundles are specified, this method will update or remove any packages exported by any bundles that were previously updated or uninstalled since the last call to this method. The technique by which this is accomplished may vary among different Framework implementations. One 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 a graph of bundles starting with the specified bundles. If no bundles are specified, compute a graph of bundles starting with bundle updated or uninstalled since the last call to this method. Add to the graph any bundle that is wired to a package that is currently exported by 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 currently still exporting packages. Each bundle in the graph that is in the `ACTIVE` state will be stopped as described in the `Bundle.stop` method. Each bundle in the graph 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 graph are no longer `RESOLVED`. Each bundle in the graph that is in the `UNINSTALLED` state is removed from the graph and is now completely removed from the Framework. Each bundle in the graph 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 another bundle offering a compatible package for export has been installed in the Framework. A framework event of type `FrameworkEvent.PACKAGES_REFRESHED` is fired. For any exceptions that are thrown during any of these steps, a `FrameworkEvent` of type `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. Parameters bundles:Bundle[] The bundles whose exported packages are to be updated or removed, or `null` for all bundles updated or uninstalled since the last call to this method. Exceptions SecurityException: If the caller does not have `AdminPermission[System Bundle,RESOLVE]` and the Java runtime environment supports permissions. IllegalArgumentException: If the specified `Bundle`s were not created by the same framework instance that registered this `PackageAdmin` service.

public void refreshPackages(Bundle[] bundles)

Forces the update (replacement) or removal of packages exported by the specified bundles.

If no bundles are specified, this method will update or remove any packages exported by any bundles that were previously updated or uninstalled since the last call to this method. The technique by which this is accomplished may vary among different Framework implementations. One 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 a graph of bundles starting with the specified bundles. If no bundles are specified, compute a graph of bundles starting with bundle updated or uninstalled since the last call to this method. Add to the graph any bundle that is wired to a package that is currently exported by 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 currently still exporting packages.
Each bundle in the graph that is in the ACTIVE state will be stopped as described in the Bundle.stop method.
Each bundle in the graph 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 graph are no longer RESOLVED.
Each bundle in the graph that is in the UNINSTALLED state is removed from the graph and is now completely removed from the Framework.
Each bundle in the graph 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 another bundle offering a compatible package for export has been installed in the Framework.
A framework event of type FrameworkEvent.PACKAGES_REFRESHED is fired.

For any exceptions that are thrown during any of these steps, a FrameworkEvent of type 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.

Parameters

bundles:Bundle[]: The bundles whose exported packages are to be updated or removed, or null for all bundles updated or uninstalled since the last call to this method.

Exceptions

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

resolveBundles back to summary

resolveBundles	back to summary
public boolean resolveBundles(Bundle[] bundles) Resolve 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 `null` is 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: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; Exceptions SecurityException: If the caller does not have `AdminPermission[System Bundle,RESOLVE]` and the Java runtime environment supports permissions. IllegalArgumentException: If the specified `Bundle`s were not created by the same framework instance that registered this `PackageAdmin` service. Since 1.2

public boolean resolveBundles(Bundle[] bundles)

Resolve 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 null is 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: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;

Exceptions

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

Since

1.2

public Interface PackageAdmin

Field Summary

Method Summary

Field Detail

Method Detail