Interface StateHelper
PlatformAdmin
provides an access point for a state
helper.
This interface is not intended to be implemented by clients.
- Since:
- 3.1
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Indicates that access is discouraged to anExportPackageDescription
.static final int
Indicates that access is encouraged to anExportPackageDescription
.static final int
An option to get all visible packages that a host bundle is currently wired to.static final int
An option to include packages available from the execution environment when getting the visible packages of a bundle. -
Method Summary
Modifier and TypeMethodDescriptionint
getAccessCode
(BundleDescription bundle, ExportPackageDescription export) Returns the access code that the specifiedBundleDescription
has to the specifiedExportPackageDescription
.getDependentBundles
(BundleDescription[] bundles) Returns all bundles in the state depending on the given bundles.getPrerequisites
(BundleDescription[] bundles) Returns all the prerequisite bundles in the state for the given bundles.Returns all unsatisfied constraints in the given bundle.getUnsatisfiedLeaves
(BundleDescription[] bundles) Returns all unsatisfied constraints in the given bundles that have no possible supplier.getVisiblePackages
(BundleDescription bundle) Returns a list of all packages that the specified bundle has access to which are exported by other bundles.getVisiblePackages
(BundleDescription bundle, int options) Returns a list of all packages that the specified bundle has access to which are exported by other bundles.boolean
isResolvable
(BundleSpecification specification) Returns whether the given bundle specification constraint is resolvable.boolean
isResolvable
(HostSpecification specification) Returns whether the given host specification constraint is resolvable.boolean
isResolvable
(ImportPackageSpecification specification) Returns whether the given package specification constraint is resolvable.Object[][]
sortBundles
(BundleDescription[] toSort) Sorts the given array of resolved bundles in pre-requisite order.
-
Field Details
-
ACCESS_ENCOURAGED
static final int ACCESS_ENCOURAGEDIndicates that access is encouraged to anExportPackageDescription
.- See Also:
-
ACCESS_DISCOURAGED
static final int ACCESS_DISCOURAGEDIndicates that access is discouraged to anExportPackageDescription
.- See Also:
-
VISIBLE_INCLUDE_EE_PACKAGES
static final int VISIBLE_INCLUDE_EE_PACKAGESAn option to include packages available from the execution environment when getting the visible packages of a bundle. For example, when running on a J2SE 1.4 VM the system bundle will export the javax.xml.parsers package as part of the execution environment. When this option is used then any packages from the execution environment which the bundle is wired to will be included. -
VISIBLE_INCLUDE_ALL_HOST_WIRES
static final int VISIBLE_INCLUDE_ALL_HOST_WIRESAn option to get all visible packages that a host bundle is currently wired to. This includes packages wired to as a result of a dynamic import and packages wired to as a result of additional constraints specified by a fragment bundle. Using this option with a fragment will cause an empty array to be returned.- Since:
- 3.6
- See Also:
-
-
Method Details
-
getDependentBundles
Returns all bundles in the state depending on the given bundles. The given bundles appear in the returned array.- Parameters:
bundles
- the initial set of bundles- Returns:
- an array containing bundle descriptions for the given roots and all bundles in the state that depend on them
-
getPrerequisites
Returns all the prerequisite bundles in the state for the given bundles. The given bundles appear in the returned array.- Parameters:
bundles
- the inital set of bundles- Returns:
- an array containing bundle descriptions for the given leaves and their prerequisite bundles in the state.
- Since:
- 3.2
-
getUnsatisfiedConstraints
Returns all unsatisfied constraints in the given bundle. Returns an empty array if no unsatisfied constraints can be found.Note that a bundle may have no unsatisfied constraints and still not be resolved.
- Parameters:
bundle
- the bundle to examine- Returns:
- an array containing all unsatisfied constraints for the given bundle
-
getUnsatisfiedLeaves
Returns all unsatisfied constraints in the given bundles that have no possible supplier. Returns an empty array if no unsatisfied leaf constraints can be found.The returned constraints include only the unsatisfied constraints in the given state that have no possible supplier (leaf constraints). There may be additional unsatisfied constraints in the given bundles but these will have at least one possible supplier. In this case the possible supplier of the constraint is not resolved for some reason. For example, a given state only has Bundles X and Y installed and Bundles X and Y have the following constraints:
Bundle X requires Bundle Y Bundle Y requires Bundle Z
In this case Bundle Y has an unsatisfied constraint leaf on Bundle Z. This will cause Bundle X's constraint on Bundle Y to be unsatisfied as well because the bundles are involved in a dependency chain. Bundle X's constraint on Bundle Y is not considered a leaf because there is a possible supplier Y in the given state.
Note that a bundle may have no unsatisfied constraints and still not be resolved.
- Parameters:
bundles
- the bundles to examine- Returns:
- an array containing all unsatisfied leaf constraints for the given bundles
- Since:
- 3.2
-
isResolvable
Returns whether the given package specification constraint is resolvable. A package specification constraint may be resolvable but not resolved, which means that the bundle that provides it has not been resolved for some other reason (e.g. another constraint could not be resolved, another version has been picked, etc).- Parameters:
specification
- the package specification constraint to be examined- Returns:
true
if the constraint can be resolved,false
otherwise
-
isResolvable
Returns whether the given bundle specification constraint is resolvable. A bundle specification constraint may be resolvable but not resolved, which means that the bundle that provides it has not been resolved for some other reason (e.g. another constraint could not be resolved, another version has been picked, etc).- Parameters:
specification
- the bundle specification constraint to be examined- Returns:
true
if the constraint can be resolved,false
otherwise
-
isResolvable
Returns whether the given host specification constraint is resolvable. A host specification constraint may be resolvable but not resolved, which means that the bundle that provides it has not been resolved for some other reason (e.g. another constraint could not be resolved, another version has been picked, etc).- Parameters:
specification
- the host specification constraint to be examined- Returns:
true
if the constraint can be resolved,false
otherwise
-
sortBundles
Sorts the given array of resolved bundles in pre-requisite order. If A requires B, A appears after B. Fragments will appear after all of their hosts. Constraints contributed by fragments will be treated as if contributed by theirs hosts, affecting their position. This is true even if the fragment does not appear in the given bundle array.Unresolved bundles are ignored.
- Parameters:
toSort
- an array of bundles to be sorted- Returns:
- any cycles found
-
getVisiblePackages
Returns a list of all packages that the specified bundle has access to which are exported by other bundles.Same as calling getVisiblePackages(bundle, 0)
- Parameters:
bundle
- a bundle to get the list of packages for.- Returns:
- a list of all packages that the specified bundle has access to which are exported by other bundles.
-
getVisiblePackages
Returns a list of all packages that the specified bundle has access to which are exported by other bundles. This takes into account all constraint specifications (Import-Package, Require-Bundle etc). A deep dependency search is done for all packages which are available through the required bundles and any bundles which are reexported. This method also takes into account all directives which may be specified on the constraint specifications (e.g. uses, x-friends etc.)- Parameters:
bundle
- a bundle to get the list of packages for.options
- the options for selecting the visible packages- Returns:
- a list of all packages that the specified bundle has access to which are exported by other bundles.
- Since:
- 3.3
- See Also:
-
getAccessCode
Returns the access code that the specifiedBundleDescription
has to the specifiedExportPackageDescription
.- Parameters:
bundle
- the bundle to find the access code forexport
- the export to find the access code for- Returns:
- the access code to the export.
- See Also:
-