ResourceConstants (Apache Felix Resolver 0.1.0.Beta3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.osgi.framework.resource
Class ResourceConstants

java.lang.Object
  org.osgi.framework.resource.ResourceConstants

public final class ResourceConstants
extends java.lang.Object
extends java.lang.Object

Defines standard names for the attributes, directives and name spaces for resources, capabilities and requirements.

The values associated with these keys are of type String, unless otherwise indicated.

Version:: $Id: ab8d42db8d410c81bccb93effa990bed1f4414df $

Field Summary
`static java.lang.String`	`CAPABILITY_EFFECTIVE_DIRECTIVE` A capability `directive` used to specify the effective time for the capability.
`static java.lang.String`	`CAPABILITY_EXCLUDE_DIRECTIVE` A capability `directive` used to specify the comma separated list of classes which must not be allowed to be exported.
`static java.lang.String`	`CAPABILITY_INCLUDE_DIRECTIVE` A capability `directive` used to specify the comma separated list of classes which must be allowed to be exported.
`static java.lang.String`	`CAPABILITY_MANDATORY_DIRECTIVE` A capability `directive` used to specify the comma separated list of mandatory attributes which must be specified in the `filter` of a requirement in order for the capability to match the requirement.
`static java.lang.String`	`CAPABILITY_USES_DIRECTIVE` A capability `directive` used to specify the comma separated list of `package` names a capability uses.
`static java.lang.String`	`EFFECTIVE_ACTIVE` A directive value identifying a `capability` or `requirement` that is effective at active time.
`static java.lang.String`	`EFFECTIVE_RESOLVE` A directive value identifying a `capability` or `requirement` that is effective at resolve time.
`static java.lang.String`	`IDENTITY_NAMESPACE` Name space for the identity capability.
`static java.lang.String`	`IDENTITY_SINGLETON_DIRECTIVE` An `identity` capability `directive` identifying if the resource is a singleton.
`static java.lang.String`	`IDENTITY_TYPE_ATTRIBUTE` An `identity` capability attribute identifying the resource type.
`static java.lang.String`	`IDENTITY_TYPE_BUNDLE` An `identity` capability `type` attribute value identifying the resource type as an OSGi bundle.
`static java.lang.String`	`IDENTITY_TYPE_FRAGMENT` An `identity` capability `type` attribute value identifying the resource type as an OSGi fragment.
`static java.lang.String`	`IDENTITY_TYPE_UNKNOWN` An `identity` capability `type` attribute value identifying the resource type as unknown.
`static java.lang.String`	`IDENTITY_VERSION_ATTRIBUTE` An `identity` capability attribute identifying the `version` of the resource.
`static java.lang.String`	`REQUIREMENT_CARDINALITY_DIRECTIVE` A requirement `directive` used to specify the cardinality for a requirement.
`static java.lang.String`	`REQUIREMENT_CARDINALITY_MULTIPLE` A directive value identifying a multiple `cardinality` type.
`static java.lang.String`	`REQUIREMENT_CARDINALITY_SINGULAR` A directive value identifying a singular `cardinality` type.
`static java.lang.String`	`REQUIREMENT_EFFECTIVE_DIRECTIVE` A requirement `directive` used to specify the effective time for the requirement.
`static java.lang.String`	`REQUIREMENT_FILTER_DIRECTIVE` A requirement `directive` used to specify a capability filter.
`static java.lang.String`	`REQUIREMENT_RESOLUTION_DIRECTIVE` A requirement `directive` used to specify the resolution type for a requirement.
`static java.lang.String`	`REQUIREMENT_RESOLUTION_DYNAMIC`
`static java.lang.String`	`REQUIREMENT_RESOLUTION_MANDATORY` A directive value identifying a mandatory `requirement` resolution type.
`static java.lang.String`	`REQUIREMENT_RESOLUTION_OPTIONAL` A directive value identifying an optional `requirement` resolution type.
`static java.lang.String`	`REQUIREMENT_VISIBILITY_DIRECTIVE` A requirement `directive` used to specify the visibility type for a requirement.
`static java.lang.String`	`REQUIREMENT_VISIBILITY_PRIVATE` A directive value identifying a private `visibility` type.
`static java.lang.String`	`REQUIREMENT_VISIBILITY_REEXPORT` A directive value identifying a reexport `visibility` type.
`static java.lang.String`	`WIRING_BUNDLE_NAMESPACE` Name space for bundle capabilities and requirements.
`static java.lang.String`	`WIRING_HOST_NAMESPACE` Name space for host capabilities and requirements.
`static java.lang.String`	`WIRING_PACKAGE_NAMESPACE` Name space for package capabilities and requirements.

Method Summary

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

IDENTITY_NAMESPACE

public static final java.lang.String IDENTITY_NAMESPACE

Name space for the identity capability. Each resource provides exactly one^† identity capability that can be used to identify the resource. For identity capability attributes the following applies:

The osgi.identity attribute contains the symbolic name of the resource.
The version attribute contains the Version of the resource.
The type attribute contains the resource type.

A resource with a symbolic name provides exactly one ^† identity capability.

For a revision with a symbolic name the wiring for the revision provides exactly one^† identity capability.

† A resource with no symbolic name must not provide an identity capability.

See Also:: Constant Field Values

IDENTITY_VERSION_ATTRIBUTE

public static final java.lang.String IDENTITY_VERSION_ATTRIBUTE

An identity capability attribute identifying the version of the resource. This attribute must be set to a value of type Version. If the resource has no version then the value 0.0.0 must be used for the attribute.

See Also:: Constant Field Values

IDENTITY_TYPE_ATTRIBUTE

public static final java.lang.String IDENTITY_TYPE_ATTRIBUTE

An identity capability attribute identifying the resource type. This attribute must be set to a value of type String. if the resource has no type then the value unknown must be used for the attribute.

See Also:: Constant Field Values

IDENTITY_TYPE_BUNDLE

public static final java.lang.String IDENTITY_TYPE_BUNDLE

An identity capability type attribute value identifying the resource type as an OSGi bundle.

See Also:: Constant Field Values

IDENTITY_TYPE_FRAGMENT

public static final java.lang.String IDENTITY_TYPE_FRAGMENT

An identity capability type attribute value identifying the resource type as an OSGi fragment.

See Also:: Constant Field Values

IDENTITY_TYPE_UNKNOWN

public static final java.lang.String IDENTITY_TYPE_UNKNOWN

An identity capability type attribute value identifying the resource type as unknown.

See Also:: Constant Field Values

IDENTITY_SINGLETON_DIRECTIVE

public static final java.lang.String IDENTITY_SINGLETON_DIRECTIVE

An identity capability directive identifying if the resource is a singleton. A String value of "true" indicates the resource is a singleton; any other value or null indicates the resource is not a singleton.

See Also:: Constant Field Values

WIRING_PACKAGE_NAMESPACE

public static final java.lang.String WIRING_PACKAGE_NAMESPACE

Name space for package capabilities and requirements. For capability attributes the following applies:

The osgi.wiring.package attribute contains the name of the package.
The version attribute contains the the Version of the package if one is specified or Version.emptyVersion if not specified.
The bundle-symbolic-name attribute contains the symbolic name of the resource providing the package if one is specified.
The bundle-version attribute contains the Version of resource providing the package if one is specified or Version.emptyVersion if not specified.
All other attributes are of type String and are used as arbitrary matching attributes for the capability.

A resource provides zero or more package capabilities (this is, exported packages) and requires zero or more package requirements (that is, imported packages).

See Also:: Constant Field Values

WIRING_BUNDLE_NAMESPACE

public static final java.lang.String WIRING_BUNDLE_NAMESPACE

Name space for bundle capabilities and requirements. For capability attributes the following applies:

The osgi.wiring.bundle attribute contains the symbolic name of the bundle.
The bundle-version attribute contains the Version of the bundle if one is specified or Version.emptyVersion if not specified.
All other attributes are of type String and are used as arbitrary matching attributes for the capability.

A non-fragment resource with the osgi.bundle type identity provides exactly one ^† bundle capability (that is, the bundle can be required by another bundle). A fragment resource with the osgi.fragment type identity must not declare a bundle capability. A resource requires zero or more bundle requirements (that is, required bundles).

† A resource with no symbolic name must not provide a bundle capability.

See Also:: Constant Field Values

WIRING_HOST_NAMESPACE

public static final java.lang.String WIRING_HOST_NAMESPACE

Name space for host capabilities and requirements. For capability attributes the following applies:

The osgi.wiring.host attribute contains the symbolic name of the bundle.
The bundle-version attribute contains the Version of the bundle if one is specified or Version.emptyVersion if not specified.
All other attributes are of type String and are used as arbitrary matching attributes for the capability.

A non-fragment resource with the with the osgi.bundle type identity provides zero or one ^† host capabilities. A fragment resource with the osgi.fragment type identity must not declare a host capability and must declare exactly one host requirement.

† A resource with no bundle symbolic name must not provide a host capability.

See Also:: Constant Field Values

REQUIREMENT_FILTER_DIRECTIVE

public static final java.lang.String REQUIREMENT_FILTER_DIRECTIVE

A requirement directive used to specify a capability filter. This filter is used to match against a capability's attributes.

See Also:: Constant Field Values

REQUIREMENT_RESOLUTION_DIRECTIVE

public static final java.lang.String REQUIREMENT_RESOLUTION_DIRECTIVE

A requirement directive used to specify the resolution type for a requirement. The default value is mandatory.

See Also:: mandatory, optional, Constant Field Values

REQUIREMENT_RESOLUTION_MANDATORY

public static final java.lang.String REQUIREMENT_RESOLUTION_MANDATORY

A directive value identifying a mandatory requirement resolution type. A mandatory resolution type indicates that the requirement must be resolved when the resource is resolved. If such requirement cannot be resolved, the resource fails to resolve.

See Also:: REQUIREMENT_RESOLUTION_DIRECTIVE, Constant Field Values

REQUIREMENT_RESOLUTION_OPTIONAL

public static final java.lang.String REQUIREMENT_RESOLUTION_OPTIONAL

A directive value identifying an optional requirement resolution type. An optional resolution type indicates that the requirement is optional and the resource may be resolved without requirement being resolved.

See Also:: REQUIREMENT_RESOLUTION_DIRECTIVE, Constant Field Values

REQUIREMENT_RESOLUTION_DYNAMIC

public static final java.lang.String REQUIREMENT_RESOLUTION_DYNAMIC

See Also:: Constant Field Values

REQUIREMENT_EFFECTIVE_DIRECTIVE

public static final java.lang.String REQUIREMENT_EFFECTIVE_DIRECTIVE

A requirement directive used to specify the effective time for the requirement. The default value is resolve.

See Also:: resolve, active, Constant Field Values

EFFECTIVE_RESOLVE

public static final java.lang.String EFFECTIVE_RESOLVE

A directive value identifying a capability or requirement that is effective at resolve time. Capabilities and requirements with an effective time of resolve are the only capabilities which are processed while resolving a resource.

See Also:: REQUIREMENT_EFFECTIVE_DIRECTIVE, CAPABILITY_EFFECTIVE_DIRECTIVE, Constant Field Values

EFFECTIVE_ACTIVE

public static final java.lang.String EFFECTIVE_ACTIVE

A directive value identifying a capability or requirement that is effective at active time. Capabilities and requirements with an effective time of active are ignored while resolving a resource.

See Also:: REQUIREMENT_EFFECTIVE_DIRECTIVE, CAPABILITY_EFFECTIVE_DIRECTIVE, Constant Field Values

REQUIREMENT_VISIBILITY_DIRECTIVE

public static final java.lang.String REQUIREMENT_VISIBILITY_DIRECTIVE

A requirement directive used to specify the visibility type for a requirement. The default value is private. This directive must only be used for requirements with the require bundle name space.

See Also:: private, reexport, Constant Field Values

REQUIREMENT_VISIBILITY_PRIVATE

public static final java.lang.String REQUIREMENT_VISIBILITY_PRIVATE

A directive value identifying a private visibility type. A private visibility type indicates that any packages that are exported by the required bundle are not made visible on the export signature of the requiring bundle .

See Also:: REQUIREMENT_VISIBILITY_DIRECTIVE, Constant Field Values

REQUIREMENT_VISIBILITY_REEXPORT

public static final java.lang.String REQUIREMENT_VISIBILITY_REEXPORT

A directive value identifying a reexport visibility type. A reexport visibility type indicates any packages that are exported by the required bundle are re-exported by the requiring bundle.

See Also:: Constant Field Values

REQUIREMENT_CARDINALITY_DIRECTIVE

public static final java.lang.String REQUIREMENT_CARDINALITY_DIRECTIVE

A requirement directive used to specify the cardinality for a requirement. The default value is singular.

See Also:: multiple, singular, Constant Field Values

REQUIREMENT_CARDINALITY_MULTIPLE

public static final java.lang.String REQUIREMENT_CARDINALITY_MULTIPLE

A directive value identifying a multiple cardinality type.

See Also:: Constant Field Values

REQUIREMENT_CARDINALITY_SINGULAR

public static final java.lang.String REQUIREMENT_CARDINALITY_SINGULAR

A directive value identifying a singular cardinality type.

See Also:: Constant Field Values

CAPABILITY_USES_DIRECTIVE

public static final java.lang.String CAPABILITY_USES_DIRECTIVE

A capability directive used to specify the comma separated list of package names a capability uses.

See Also:: Constant Field Values

CAPABILITY_EFFECTIVE_DIRECTIVE

public static final java.lang.String CAPABILITY_EFFECTIVE_DIRECTIVE

A capability directive used to specify the effective time for the capability. The default value is resolve.

See Also:: resolve, active, Constant Field Values

CAPABILITY_MANDATORY_DIRECTIVE

public static final java.lang.String CAPABILITY_MANDATORY_DIRECTIVE

A capability directive used to specify the comma separated list of mandatory attributes which must be specified in the filter of a requirement in order for the capability to match the requirement. This directive must only be used for capabilities with the package, bundle, or host name space.

See Also:: Constant Field Values

CAPABILITY_INCLUDE_DIRECTIVE

public static final java.lang.String CAPABILITY_INCLUDE_DIRECTIVE

A capability directive used to specify the comma separated list of classes which must be allowed to be exported. This directive must only be used for capabilities with the package name space.

See Also:: Constant Field Values

CAPABILITY_EXCLUDE_DIRECTIVE

public static final java.lang.String CAPABILITY_EXCLUDE_DIRECTIVE

A capability directive used to specify the comma separated list of classes which must not be allowed to be exported. This directive must only be used for capabilities with the package name space.

See Also:: Constant Field Values