OSGi 8.1.0 · org.osgi.framework.wiring.BundleWiring · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	FINDENTRIES_RECURSE The find entries operation must recurse into subdirectories.
public static final int	LISTRESOURCES_LOCAL The list resource names operation must limit the result to the names of matching resources contained in this bundle wiring's `bundle revision` and its attached fragment revisions.
public static final int	LISTRESOURCES_RECURSE The list resource names operation must recurse into subdirectories.

Method Summary

Modifier and Type	Method and Description
public List<URL>	Returns: An unmodifiable list of URL objects for each matching entry, or an empty list if no matching entry could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate `AdminPermission[bundle,RESOURCE]` and the Java Runtime Environment supports permissions. The list is ordered such that entries from the `bundle revision` are returned first followed by the entries from attached fragment revisions in attachment order. If this bundle wiring is not `in use`, `null` must be returned. findEntries(String The path name in which to look. The path is always relative to the root of this bundle wiring and may begin with "/". A path value of "/" indicates the root of this bundle wiring. path, String The file name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the entry path. If the entry is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character (""). If `null` is specified, this is equivalent to "" and matches all files. filePattern, int The options for listing resource names. See `FINDENTRIES_RECURSE`. The method must ignore unrecognized options. options) Returns entries in this bundle wiring's `bundle revision` and its attached fragment revisions.
public List<BundleCapability>	Returns: A list containing a snapshot of the `BundleCapability`s, or an empty list if this bundle wiring provides no capabilities in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the `bundle revision` and the attached fragments^† of this bundle wiring. There is no ordering defined between capabilities in different namespaces. getCapabilities(String The namespace of the capabilities to return or `null` to return the capabilities from all namespaces. namespace) Returns the capabilities provided by this bundle wiring.
public ClassLoader	Returns: The class loader for this bundle wiring. If this bundle wiring is not `in use` or this bundle wiring is for a fragment revision, `null` will be returned. getClassLoader() Returns the class loader for this bundle wiring.
public List<Wire>	Returns: A list containing a snapshot of the `Wire`s for the `capabilities` of this wiring, or an empty list if this wiring has no capabilities in the specified namespace. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between capabilities in different namespaces. getProvidedResourceWires(String The namespace of the capabilities for which to return wires or `null` to return the wires for the capabilities in all namespaces. namespace) Redeclares org.osgi.resource.Wiring.getProvidedResourceWires. Returns the `Wire`s to the provided `capabilities` of this wiring.
public List<BundleWire>	Returns: A list containing a snapshot of the `BundleWire`s for the `capabilities` of this bundle wiring, or an empty list if this bundle wiring has no capabilities in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring. There is no ordering defined between capabilities in different namespaces. getProvidedWires(String The namespace of the capabilities for which to return wires or `null` to return the wires for the capabilities in all namespaces. namespace) Returns the `BundleWire`s to the provided `capabilities` of this bundle wiring.
public List<Wire>	Returns: A list containing a snapshot of the `Wire`s for the `requirements` of this wiring, or an empty list if this wiring has no requirements in the specified namespace. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces. getRequiredResourceWires(String The namespace of the requirements for which to return wires or `null` to return the wires for the requirements in all namespaces. namespace) Redeclares org.osgi.resource.Wiring.getRequiredResourceWires. Returns the `Wire`s to the `requirements` in use by this wiring.
public List<BundleWire>	Returns: A list containing a snapshot of the `BundleWire`s for the `requirements` of this bundle wiring, or an empty list if this bundle wiring has no requirements in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring followed by dynamically established wires, if any, in the order they were established. There is no ordering defined between requirements in different namespaces. getRequiredWires(String The namespace of the requirements for which to return wires or `null` to return the wires for the requirements in all namespaces. namespace) Returns the `BundleWire`s to the `requirements` in use by this bundle wiring.
public List<BundleRequirement>	Returns: A list containing a snapshot of the `BundleRequirement`s, or an empty list if this bundle wiring uses no requirements in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring. There is no ordering defined between requirements in different namespaces. getRequirements(String The namespace of the requirements to return or `null` to return the requirements from all namespaces. namespace) Returns the requirements of this bundle wiring.
public BundleRevision	Returns: The resource associated with this wiring. getResource() Redeclares org.osgi.resource.Wiring.getResource. Returns the resource associated with this wiring.
public List<Capability>	Returns: A list containing a snapshot of the `Capability`s, or an empty list if this wiring provides no capabilities in the specified namespace. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the `resource` and the attached fragment resources^† of this wiring. There is no ordering defined between capabilities in different namespaces. getResourceCapabilities(String The namespace of the capabilities to return or `null` to return the capabilities from all namespaces. namespace) Redeclares org.osgi.resource.Wiring.getResourceCapabilities. Returns the capabilities provided by this wiring.
public List<Requirement>	Returns: A list containing a snapshot of the `Requirement`s, or an empty list if this wiring uses no requirements in the specified namespace. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces. getResourceRequirements(String The namespace of the requirements to return or `null` to return the requirements from all namespaces. namespace) Redeclares org.osgi.resource.Wiring.getResourceRequirements. Returns the requirements of this wiring.
public BundleRevision	Returns: The bundle revision for this bundle wiring. getRevision() Returns the bundle revision for the bundle in this bundle wiring.
public boolean	Returns: `true` if this bundle wiring is the current bundle wiring; `false` otherwise. isCurrent() Returns `true` if this bundle wiring is the current bundle wiring.
public boolean	Returns: `true` if this bundle wiring is in use; `false` otherwise. isInUse() Returns `true` if this bundle wiring is in use.
public Collection<String>	Returns: An unmodifiable collection of resource names for each matching resource, or an empty collection if no matching resource could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate `AdminPermission[bundle,RESOURCE]` and the Java Runtime Environment supports permissions. The collection is unordered and must contain no duplicate resource names. If this bundle wiring is not `in use`, `null` must be returned. listResources(String The path name in which to look. The path is always relative to the root of this bundle wiring's class loader and may begin with "/". A path value of "/" indicates the root of this bundle wiring's class loader. path, String The file name pattern for selecting resource names in the specified path. The pattern is only matched against the last element of the resource path. If the resource is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character (""). If `null` is specified, this is equivalent to "" and matches all files. filePattern, int The options for listing resource names. See `LISTRESOURCES_LOCAL` and `LISTRESOURCES_RECURSE`. This method must ignore unrecognized options. options) Returns the names of resources visible to this bundle wiring's `class loader`.

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

FINDENTRIES_RECURSE	back to summary
public static final int FINDENTRIES_RECURSE The find entries operation must recurse into subdirectories. This bit may be set when calling `findEntries(String, String, int)` to specify the result must include the matching entries from the specified path and its subdirectories. If this bit is not set, then the result must only include matching entries from the specified path. See Also `findEntries(String, String, int)`

LISTRESOURCES_LOCAL	back to summary
public static final int LISTRESOURCES_LOCAL The list resource names operation must limit the result to the names of matching resources contained in this bundle wiring's `bundle revision` and its attached fragment revisions. The result must not include resource names for resources in `package` names which are `imported` by this wiring. This bit may be set when calling `listResources(String, String, int)` to specify the result must only include the names of matching resources contained in this bundle wiring's bundle revision and its attached fragment revisions. If this bit is not set, then the result must include the names of matching resources reachable from this bundle wiring's class loader which may include the names of matching resources contained in imported packages and required bundles. See Also `listResources(String, String, int)`

LISTRESOURCES_RECURSE	back to summary
public static final int LISTRESOURCES_RECURSE The list resource names operation must recurse into subdirectories. This bit may be set when calling `listResources(String, String, int)` to specify the result must include the names of matching resources from the specified path and its subdirectories. If this bit is not set, then the result must only include names of matching resources from the specified path. See Also `listResources(String, String, int)`

Method Detail

findEntries back to summary

findEntries	back to summary
public List<URL> findEntries(String path, String filePattern, int options) Returns entries in this bundle wiring's `bundle revision` and its attached fragment revisions. This bundle wiring's class loader is not used to search for entries. Only the contents of this bundle wiring's bundle revision and its attached fragment revisions are searched for the specified entries. This method takes into account that the "contents" of this bundle wiring can have attached fragments. This "bundle space" is not a namespace with unique members; the same entry name can be present multiple times. This method therefore returns a list of URL objects. These URLs can come from different JARs but have the same path name. This method can either return only entries in the specified path or recurse into subdirectories returning entries in the directory tree beginning at the specified path. URLs for directory entries must have their path end with "/". Note Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the bundle contents do not contain directory entries. Parameters path:String The path name in which to look. The path is always relative to the root of this bundle wiring and may begin with "/". A path value of "/" indicates the root of this bundle wiring. filePattern:String The file name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the entry path. If the entry is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character (""). If `null` is specified, this is equivalent to "" and matches all files. options:int The options for listing resource names. See `FINDENTRIES_RECURSE`. The method must ignore unrecognized options. Returns:List<URL> An unmodifiable list of URL objects for each matching entry, or an empty list if no matching entry could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate `AdminPermission[bundle,RESOURCE]` and the Java Runtime Environment supports permissions. The list is ordered such that entries from the `bundle revision` are returned first followed by the entries from attached fragment revisions in attachment order. If this bundle wiring is not `in use`, `null` must be returned. See Also `Bundle#findEntries(String, String, boolean)`

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

Returns entries in this bundle wiring's bundle revision and its attached fragment revisions. This bundle wiring's class loader is not used to search for entries. Only the contents of this bundle wiring's bundle revision and its attached fragment revisions are searched for the specified entries.

This method takes into account that the "contents" of this bundle wiring can have attached fragments. This "bundle space" is not a namespace with unique members; the same entry name can be present multiple times. This method therefore returns a list of URL objects. These URLs can come from different JARs but have the same path name. This method can either return only entries in the specified path or recurse into subdirectories returning entries in the directory tree beginning at the specified path.

URLs for directory entries must have their path end with "/".

Note

Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the bundle contents do not contain directory entries.

Parameters

path:String: The path name in which to look. The path is always relative to the root of this bundle wiring and may begin with "/". A path value of "/" indicates the root of this bundle wiring.
filePattern:String: The file name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the entry path. If the entry is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character ("*"). If null is specified, this is equivalent to "*" and matches all files.
options:int: The options for listing resource names. See FINDENTRIES_RECURSE. The method must ignore unrecognized options.

Returns:List<URL>

An unmodifiable list of URL objects for each matching entry, or an empty list if no matching entry could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate AdminPermission[bundle,RESOURCE] and the Java Runtime Environment supports permissions. The list is ordered such that entries from the bundle revision are returned first followed by the entries from attached fragment revisions in attachment order. If this bundle wiring is not in use, null must be returned.

getCapabilities back to summary

getCapabilities	back to summary
public List<BundleCapability> getCapabilities(String namespace) Returns the capabilities provided by this bundle wiring. Only capabilities considered by the resolver are returned. For example, capabilities with `effective` directive not equal to `resolve` are not returned. A capability may not be required by any bundle wiring and thus there may be no `wires` for the capability. A bundle wiring for a non-fragment revision provides a subset of the declared capabilities from the bundle revision and all attached fragment revisions^†. Not all declared capabilities may be provided since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded. A bundle wiring for a fragment revision with a symbolic name must provide exactly one `identity` capability. † The `identity` capability provided by attached fragment revisions must not be included in the capabilities of the host bundle wiring. Parameters namespace:String The namespace of the capabilities to return or `null` to return the capabilities from all namespaces. Returns:List<BundleCapability> A list containing a snapshot of the `BundleCapability`s, or an empty list if this bundle wiring provides no capabilities in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the `bundle revision` and the attached fragments^† of this bundle wiring. There is no ordering defined between capabilities in different namespaces.

public List<BundleCapability> getCapabilities(String namespace)

Returns the capabilities provided by this bundle wiring.

Only capabilities considered by the resolver are returned. For example, capabilities with effective directive not equal to resolve are not returned.

A capability may not be required by any bundle wiring and thus there may be no wires for the capability.

A bundle wiring for a non-fragment revision provides a subset of the declared capabilities from the bundle revision and all attached fragment revisions^†. Not all declared capabilities may be provided since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded.

A bundle wiring for a fragment revision with a symbolic name must provide exactly one identity capability.

† The identity capability provided by attached fragment revisions must not be included in the capabilities of the host bundle wiring.

Parameters

namespace:String: The namespace of the capabilities to return or null to return the capabilities from all namespaces.

Returns:List<BundleCapability>

A list containing a snapshot of the BundleCapabilitys, or an empty list if this bundle wiring provides no capabilities in the specified namespace. If this bundle wiring is not in use, null will be returned. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the bundle revision and the attached fragments^† of this bundle wiring. There is no ordering defined between capabilities in different namespaces.

getClassLoader back to summary

getClassLoader	back to summary
public ClassLoader getClassLoader() Returns the class loader for this bundle wiring. Since a bundle refresh creates a new bundle wiring for a bundle, different bundle wirings for the same bundle will have different class loaders. Returns:ClassLoader The class loader for this bundle wiring. If this bundle wiring is not `in use` or this bundle wiring is for a fragment revision, `null` will be returned. Exceptions SecurityException: If the caller does not have the appropriate `RuntimePermission("getClassLoader")`, and the Java Runtime Environment supports permissions.

public ClassLoader getClassLoader()

Returns the class loader for this bundle wiring. Since a bundle refresh creates a new bundle wiring for a bundle, different bundle wirings for the same bundle will have different class loaders.

Returns:ClassLoader

The class loader for this bundle wiring. If this bundle wiring is not in use or this bundle wiring is for a fragment revision, null will be returned.

Exceptions

SecurityException:: If the caller does not have the appropriate RuntimePermission("getClassLoader"), and the Java Runtime Environment supports permissions.

getProvidedResourceWires back to summary

getProvidedResourceWires	back to summary
public List<Wire> getProvidedResourceWires(String namespace) Redeclares org.osgi.resource.Wiring.getProvidedResourceWires. Returns the `Wire`s to the provided `capabilities` of this wiring. This method returns the same value as `getProvidedWires(String)`. Parameters namespace:String The namespace of the capabilities for which to return wires or `null` to return the wires for the capabilities in all namespaces. Returns:List<Wire> A list containing a snapshot of the `Wire`s for the `capabilities` of this wiring, or an empty list if this wiring has no capabilities in the specified namespace. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between capabilities in different namespaces. Annotations @Override Since 1.1

public List<Wire> getProvidedResourceWires(String namespace)

Redeclares org.osgi.resource.Wiring.getProvidedResourceWires.

Returns the Wires to the provided capabilities of this wiring.

This method returns the same value as getProvidedWires(String).

Parameters

namespace:String: The namespace of the capabilities for which to return wires or null to return the wires for the capabilities in all namespaces.

Returns:List<Wire>

A list containing a snapshot of the Wires for the capabilities of this wiring, or an empty list if this wiring has no capabilities in the specified namespace. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the resource and the attached fragment resources of this wiring. There is no ordering defined between capabilities in different namespaces.

Annotations

@Override

Since

1.1

getProvidedWires back to summary

getProvidedWires	back to summary
public List<BundleWire> getProvidedWires(String namespace) Returns the `BundleWire`s to the provided `capabilities` of this bundle wiring. Parameters namespace:String The namespace of the capabilities for which to return wires or `null` to return the wires for the capabilities in all namespaces. Returns:List<BundleWire> A list containing a snapshot of the `BundleWire`s for the `capabilities` of this bundle wiring, or an empty list if this bundle wiring has no capabilities in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring. There is no ordering defined between capabilities in different namespaces.

public List<BundleWire> getProvidedWires(String namespace)

Returns the BundleWires to the provided capabilities of this bundle wiring.

Parameters

namespace:String: The namespace of the capabilities for which to return wires or null to return the wires for the capabilities in all namespaces.

Returns:List<BundleWire>

A list containing a snapshot of the BundleWires for the capabilities of this bundle wiring, or an empty list if this bundle wiring has no capabilities in the specified namespace. If this bundle wiring is not in use, null will be returned. For a given namespace, the list contains the wires in the order the capabilities were specified in the manifests of the bundle revision and the attached fragments of this bundle wiring. There is no ordering defined between capabilities in different namespaces.

getRequiredResourceWires back to summary

getRequiredResourceWires	back to summary
public List<Wire> getRequiredResourceWires(String namespace) Redeclares org.osgi.resource.Wiring.getRequiredResourceWires. Returns the `Wire`s to the `requirements` in use by this wiring. This method returns the same value as `getRequiredWires(String)`. Parameters namespace:String The namespace of the requirements for which to return wires or `null` to return the wires for the requirements in all namespaces. Returns:List<Wire> A list containing a snapshot of the `Wire`s for the `requirements` of this wiring, or an empty list if this wiring has no requirements in the specified namespace. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces. Annotations @Override Since 1.1

public List<Wire> getRequiredResourceWires(String namespace)

Redeclares org.osgi.resource.Wiring.getRequiredResourceWires.

Returns the Wires to the requirements in use by this wiring.

This method returns the same value as getRequiredWires(String).

Parameters

namespace:String: The namespace of the requirements for which to return wires or null to return the wires for the requirements in all namespaces.

Returns:List<Wire>

A list containing a snapshot of the Wires for the requirements of this wiring, or an empty list if this wiring has no requirements in the specified namespace. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the resource and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces.

Annotations

@Override

Since

1.1

getRequiredWires back to summary

getRequiredWires	back to summary
public List<BundleWire> getRequiredWires(String namespace) Returns the `BundleWire`s to the `requirements` in use by this bundle wiring. This method may return different results if this bundle wiring establishes additional wires to more requirements. For example, dynamically importing a package will establish a new wire to the dynamically imported package. Parameters namespace:String The namespace of the requirements for which to return wires or `null` to return the wires for the requirements in all namespaces. Returns:List<BundleWire> A list containing a snapshot of the `BundleWire`s for the `requirements` of this bundle wiring, or an empty list if this bundle wiring has no requirements in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring followed by dynamically established wires, if any, in the order they were established. There is no ordering defined between requirements in different namespaces.

public List<BundleWire> getRequiredWires(String namespace)

Returns the BundleWires to the requirements in use by this bundle wiring.

This method may return different results if this bundle wiring establishes additional wires to more requirements. For example, dynamically importing a package will establish a new wire to the dynamically imported package.

Parameters

namespace:String: The namespace of the requirements for which to return wires or null to return the wires for the requirements in all namespaces.

Returns:List<BundleWire>

A list containing a snapshot of the BundleWires for the requirements of this bundle wiring, or an empty list if this bundle wiring has no requirements in the specified namespace. If this bundle wiring is not in use, null will be returned. For a given namespace, the list contains the wires in the order the requirements were specified in the manifests of the bundle revision and the attached fragments of this bundle wiring followed by dynamically established wires, if any, in the order they were established. There is no ordering defined between requirements in different namespaces.

getRequirements back to summary

getRequirements	back to summary
public List<BundleRequirement> getRequirements(String namespace) Returns the requirements of this bundle wiring. Only requirements considered by the resolver are returned. For example, requirements with `effective` directive not equal to `resolve` are not returned. A bundle wiring for a non-fragment revision has a subset of the declared requirements from the bundle revision and all attached fragment revisions. Not all declared requirements may be present since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded. Parameters namespace:String The namespace of the requirements to return or `null` to return the requirements from all namespaces. Returns:List<BundleRequirement> A list containing a snapshot of the `BundleRequirement`s, or an empty list if this bundle wiring uses no requirements in the specified namespace. If this bundle wiring is not `in use`, `null` will be returned. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the `bundle revision` and the attached fragments of this bundle wiring. There is no ordering defined between requirements in different namespaces.

public List<BundleRequirement> getRequirements(String namespace)

Returns the requirements of this bundle wiring.

Only requirements considered by the resolver are returned. For example, requirements with effective directive not equal to resolve are not returned.

A bundle wiring for a non-fragment revision has a subset of the declared requirements from the bundle revision and all attached fragment revisions. Not all declared requirements may be present since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded.

Parameters

namespace:String: The namespace of the requirements to return or null to return the requirements from all namespaces.

Returns:List<BundleRequirement>

A list containing a snapshot of the BundleRequirements, or an empty list if this bundle wiring uses no requirements in the specified namespace. If this bundle wiring is not in use, null will be returned. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the bundle revision and the attached fragments of this bundle wiring. There is no ordering defined between requirements in different namespaces.

getResource back to summary

getResource	back to summary
public BundleRevision getResource() Redeclares org.osgi.resource.Wiring.getResource. Returns the resource associated with this wiring. This method returns the same value as `getRevision()`. Returns:BundleRevision The resource associated with this wiring. Annotations @Override Since 1.1

public BundleRevision getResource()

Redeclares org.osgi.resource.Wiring.getResource.

Returns the resource associated with this wiring.

This method returns the same value as getRevision().

Returns:BundleRevision

The resource associated with this wiring.

Annotations

@Override

Since

1.1

getResourceCapabilities back to summary

getResourceCapabilities	back to summary
public List<Capability> getResourceCapabilities(String namespace) Redeclares org.osgi.resource.Wiring.getResourceCapabilities. Returns the capabilities provided by this wiring. Only capabilities considered by the resolver are returned. For example, capabilities with `effective` directive not equal to `resolve` are not returned. A capability may not be required by any wiring and thus there may be no `wires` for the capability. A wiring for a non-fragment resource provides a subset of the declared capabilities from the resource and all attached fragment resources^†. Not all declared capabilities may be provided since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded. A wiring for a fragment resource with a symbolic name must provide exactly one `osgi.identity` capability. † The `osgi.identity` capability provided by attached fragment resource must not be included in the capabilities of the host wiring. This method returns the same value as `getCapabilities(String)`. Parameters namespace:String The namespace of the capabilities to return or `null` to return the capabilities from all namespaces. Returns:List<Capability> A list containing a snapshot of the `Capability`s, or an empty list if this wiring provides no capabilities in the specified namespace. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the `resource` and the attached fragment resources^† of this wiring. There is no ordering defined between capabilities in different namespaces. Annotations @Override Since 1.1

public List<Capability> getResourceCapabilities(String namespace)

Redeclares org.osgi.resource.Wiring.getResourceCapabilities.

Returns the capabilities provided by this wiring.

Only capabilities considered by the resolver are returned. For example, capabilities with effective directive not equal to resolve are not returned.

A capability may not be required by any wiring and thus there may be no wires for the capability.

A wiring for a non-fragment resource provides a subset of the declared capabilities from the resource and all attached fragment resources^†. Not all declared capabilities may be provided since some may be discarded. For example, if a package is declared to be both exported and imported, only one is selected and the other is discarded.

A wiring for a fragment resource with a symbolic name must provide exactly one osgi.identity capability.

† The osgi.identity capability provided by attached fragment resource must not be included in the capabilities of the host wiring.

This method returns the same value as getCapabilities(String).

Parameters

namespace:String: The namespace of the capabilities to return or null to return the capabilities from all namespaces.

Returns:List<Capability>

A list containing a snapshot of the Capabilitys, or an empty list if this wiring provides no capabilities in the specified namespace. For a given namespace, the list contains the capabilities in the order the capabilities were specified in the manifests of the resource and the attached fragment resources^† of this wiring. There is no ordering defined between capabilities in different namespaces.

Annotations

@Override

Since

1.1

getResourceRequirements back to summary

getResourceRequirements	back to summary
public List<Requirement> getResourceRequirements(String namespace) Redeclares org.osgi.resource.Wiring.getResourceRequirements. Returns the requirements of this wiring. Only requirements considered by the resolver are returned. For example, requirements with `effective` directive not equal to `resolve` are not returned. A wiring for a non-fragment resource has a subset of the declared requirements from the resource and all attached fragment resources. Not all declared requirements may be present since some may be discarded. For example, if a package is declared to be optionally imported and is not actually imported, the requirement must be discarded. This method returns the same value as `getRequirements(String)`. Parameters namespace:String The namespace of the requirements to return or `null` to return the requirements from all namespaces. Returns:List<Requirement> A list containing a snapshot of the `Requirement`s, or an empty list if this wiring uses no requirements in the specified namespace. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the `resource` and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces. Annotations @Override Since 1.1

public List<Requirement> getResourceRequirements(String namespace)

Redeclares org.osgi.resource.Wiring.getResourceRequirements.

Returns the requirements of this wiring.

Only requirements considered by the resolver are returned. For example, requirements with effective directive not equal to resolve are not returned.

A wiring for a non-fragment resource has a subset of the declared requirements from the resource and all attached fragment resources. Not all declared requirements may be present since some may be discarded. For example, if a package is declared to be optionally imported and is not actually imported, the requirement must be discarded.

This method returns the same value as getRequirements(String).

Parameters

namespace:String: The namespace of the requirements to return or null to return the requirements from all namespaces.

Returns:List<Requirement>

A list containing a snapshot of the Requirements, or an empty list if this wiring uses no requirements in the specified namespace. For a given namespace, the list contains the requirements in the order the requirements were specified in the manifests of the resource and the attached fragment resources of this wiring. There is no ordering defined between requirements in different namespaces.

Annotations

@Override

Since

1.1

getRevision back to summary

getRevision	back to summary
public BundleRevision getRevision() Returns the bundle revision for the bundle in this bundle wiring. Since a bundle update can change the entries in a bundle, different bundle wirings for the same bundle can have different bundle revisions. The bundle object `referenced` by the returned `BundleRevision` may return different information than the returned `BundleRevision` since the returned `BundleRevision` may refer to an older revision of the bundle. Returns:BundleRevision The bundle revision for this bundle wiring. See Also `BundleRevision#getWiring()`

public BundleRevision getRevision()

Returns the bundle revision for the bundle in this bundle wiring. Since a bundle update can change the entries in a bundle, different bundle wirings for the same bundle can have different bundle revisions.

The bundle object referenced by the returned BundleRevision may return different information than the returned BundleRevision since the returned BundleRevision may refer to an older revision of the bundle.

Returns:BundleRevision: The bundle revision for this bundle wiring.
See Also: BundleRevision#getWiring()

isCurrent back to summary

isCurrent	back to summary
public boolean isCurrent() Returns `true` if this bundle wiring is the current bundle wiring. The bundle wiring for a bundle is the current bundle wiring if it is the most recent bundle wiring for the current bundle revision. All bundles with non-current, in use bundle wirings are considered `removal pending`. Returns:boolean `true` if this bundle wiring is the current bundle wiring; `false` otherwise.

public boolean isCurrent()

Returns true if this bundle wiring is the current bundle wiring. The bundle wiring for a bundle is the current bundle wiring if it is the most recent bundle wiring for the current bundle revision. All bundles with non-current, in use bundle wirings are considered removal pending.

Returns:boolean: true if this bundle wiring is the current bundle wiring; false otherwise.

isInUse back to summary

isInUse	back to summary
public boolean isInUse() Returns `true` if this bundle wiring is in use. A bundle wiring is in use if it is the `current` wiring or if some other in use bundle wiring is dependent upon it. Once a bundle wiring is no longer in use, it is considered stale and is discarded by the framework. Returns:boolean `true` if this bundle wiring is in use; `false` otherwise.

public boolean isInUse()

Returns true if this bundle wiring is in use. A bundle wiring is in use if it is the current wiring or if some other in use bundle wiring is dependent upon it. Once a bundle wiring is no longer in use, it is considered stale and is discarded by the framework.

Returns:boolean: true if this bundle wiring is in use; false otherwise.

listResources back to summary

listResources	back to summary
public Collection<String> listResources(String path, String filePattern, int options) Returns the names of resources visible to this bundle wiring's `class loader`. The returned names can be used to access the resources via this bundle wiring's class loader. Only the resource names for resources in bundle wirings will be returned. The names of resources visible to a bundle wiring's parent class loader, such as the bootstrap class loader, must not be included in the result. Only established wires will be examined for resources. This method must not cause new wires for dynamic imports to be established. Parameters path:String The path name in which to look. The path is always relative to the root of this bundle wiring's class loader and may begin with "/". A path value of "/" indicates the root of this bundle wiring's class loader. filePattern:String The file name pattern for selecting resource names in the specified path. The pattern is only matched against the last element of the resource path. If the resource is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character (""). If `null` is specified, this is equivalent to "" and matches all files. options:int The options for listing resource names. See `LISTRESOURCES_LOCAL` and `LISTRESOURCES_RECURSE`. This method must ignore unrecognized options. Returns:Collection<String> An unmodifiable collection of resource names for each matching resource, or an empty collection if no matching resource could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate `AdminPermission[bundle,RESOURCE]` and the Java Runtime Environment supports permissions. The collection is unordered and must contain no duplicate resource names. If this bundle wiring is not `in use`, `null` must be returned.

public Collection<String> listResources(String path, String filePattern, int options)

Returns the names of resources visible to this bundle wiring's class loader. The returned names can be used to access the resources via this bundle wiring's class loader.

Only the resource names for resources in bundle wirings will be returned. The names of resources visible to a bundle wiring's parent class loader, such as the bootstrap class loader, must not be included in the result.
Only established wires will be examined for resources. This method must not cause new wires for dynamic imports to be established.

Parameters

path:String: The path name in which to look. The path is always relative to the root of this bundle wiring's class loader and may begin with "/". A path value of "/" indicates the root of this bundle wiring's class loader.
filePattern:String: The file name pattern for selecting resource names in the specified path. The pattern is only matched against the last element of the resource path. If the resource is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character ("*"). If null is specified, this is equivalent to "*" and matches all files.
options:int: The options for listing resource names. See LISTRESOURCES_LOCAL and LISTRESOURCES_RECURSE. This method must ignore unrecognized options.

Returns:Collection<String>

An unmodifiable collection of resource names for each matching resource, or an empty collection if no matching resource could be found, if this bundle wiring is for a fragment revision or if the caller does not have the appropriate AdminPermission[bundle,RESOURCE] and the Java Runtime Environment supports permissions. The collection is unordered and must contain no duplicate resource names. If this bundle wiring is not in use, null must be returned.

public Interface BundleWiring

Field Summary

Method Summary

Field Detail

Method Detail