org.osgi.framework.Constants Interface Reference

List of all members.


Detailed Description

Defines standard names for the OSGi environment property, service property, and Manifest header attribute keys.

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

Version:
Revision
1.25
Since:
1.1

Definition at line 33 of file Constants.java.


Static Public Attributes

static final String SYSTEM_BUNDLE_LOCATION = "System Bundle"
 Location identifier of the OSGi system bundle , which is defined to be "System Bundle".
static final String SYSTEM_BUNDLE_SYMBOLICNAME = "system.bundle"
 Alias for the symbolic name of the OSGi system bundle .
static final String BUNDLE_CATEGORY = "Bundle-Category"
 Manifest header (named "Bundle-Category") identifying the bundle's category.
static final String BUNDLE_CLASSPATH = "Bundle-ClassPath"
 Manifest header (named "Bundle-ClassPath") identifying a list of directories and embedded JAR files, which are bundle resources used to extend the bundle's classpath.
static final String BUNDLE_COPYRIGHT = "Bundle-Copyright"
 Manifest header (named "Bundle-Copyright") identifying the bundle's copyright information.
static final String BUNDLE_DESCRIPTION = "Bundle-Description"
 Manifest header (named "Bundle-Description") containing a brief description of the bundle's functionality.
static final String BUNDLE_NAME = "Bundle-Name"
 Manifest header (named "Bundle-Name") identifying the bundle's name.
static final String BUNDLE_NATIVECODE = "Bundle-NativeCode"
 Manifest header (named "Bundle-NativeCode") identifying a number of hardware environments and the native language code libraries that the bundle is carrying for each of these environments.
static final String EXPORT_PACKAGE = "Export-Package"
 Manifest header (named "Export-Package") identifying the packages that the bundle offers to the Framework for export.
static final String EXPORT_SERVICE = "Export-Service"
 Manifest header (named "Export-Service") identifying the fully qualified class names of the services that the bundle may register (used for informational purposes only).
static final String IMPORT_PACKAGE = "Import-Package"
 Manifest header (named "Import-Package") identifying the packages on which the bundle depends.
static final String DYNAMICIMPORT_PACKAGE = "DynamicImport-Package"
 Manifest header (named "DynamicImport-Package") identifying the packages that the bundle may dynamically import during execution.
static final String IMPORT_SERVICE = "Import-Service"
 Manifest header (named "Import-Service") identifying the fully qualified class names of the services that the bundle requires (used for informational purposes only).
static final String BUNDLE_VENDOR = "Bundle-Vendor"
 Manifest header (named "Bundle-Vendor") identifying the bundle's vendor.
static final String BUNDLE_VERSION = "Bundle-Version"
 Manifest header (named "Bundle-Version") identifying the bundle's version.
static final String BUNDLE_DOCURL = "Bundle-DocURL"
 Manifest header (named "Bundle-DocURL") identifying the bundle's documentation URL, from which further information about the bundle may be obtained.
static final String BUNDLE_CONTACTADDRESS = "Bundle-ContactAddress"
 Manifest header (named "Bundle-ContactAddress") identifying the contact address where problems with the bundle may be reported; for example, an email address.
static final String BUNDLE_ACTIVATOR = "Bundle-Activator"
 Manifest header attribute (named "Bundle-Activator") identifying the bundle's activator class.
static final String BUNDLE_UPDATELOCATION = "Bundle-UpdateLocation"
 Manifest header (named "Bundle-UpdateLocation") identifying the location from which a new bundle version is obtained during a bundle update operation.
static final String PACKAGE_SPECIFICATION_VERSION = "specification-version"
 Manifest header attribute (named "specification-version") identifying the version of a package specified in the Export-Package or Import-Package manifest header.
static final String BUNDLE_NATIVECODE_PROCESSOR = "processor"
 Manifest header attribute (named "processor") identifying the processor required to run native bundle code specified in the Bundle-NativeCode manifest header).
static final String BUNDLE_NATIVECODE_OSNAME = "osname"
 Manifest header attribute (named "osname") identifying the operating system required to run native bundle code specified in the Bundle-NativeCode manifest header).
static final String BUNDLE_NATIVECODE_OSVERSION = "osversion"
 Manifest header attribute (named "osversion") identifying the operating system version required to run native bundle code specified in the Bundle-NativeCode manifest header).
static final String BUNDLE_NATIVECODE_LANGUAGE = "language"
 Manifest header attribute (named "language") identifying the language in which the native bundle code is written specified in the Bundle-NativeCode manifest header.
static final String BUNDLE_REQUIREDEXECUTIONENVIRONMENT = "Bundle-RequiredExecutionEnvironment"
 Manifest header (named "Bundle-RequiredExecutionEnvironment") identifying the required execution environment for the bundle.
static final String FRAMEWORK_VERSION = "org.osgi.framework.version"
 Framework environment property (named "org.osgi.framework.version") identifying the Framework version.
static final String FRAMEWORK_VENDOR = "org.osgi.framework.vendor"
 Framework environment property (named "org.osgi.framework.vendor") identifying the Framework implementation vendor.
static final String FRAMEWORK_LANGUAGE = "org.osgi.framework.language"
 Framework environment property (named "org.osgi.framework.language") identifying the Framework implementation language (see ISO 639 for possible values).
static final String FRAMEWORK_OS_NAME = "org.osgi.framework.os.name"
 Framework environment property (named "org.osgi.framework.os.name") identifying the Framework host-computer's operating system.
static final String FRAMEWORK_OS_VERSION = "org.osgi.framework.os.version"
 Framework environment property (named "org.osgi.framework.os.version") identifying the Framework host-computer's operating system version number.
static final String FRAMEWORK_PROCESSOR = "org.osgi.framework.processor"
 Framework environment property (named "org.osgi.framework.processor") identifying the Framework host-computer's processor name.
static final String FRAMEWORK_EXECUTIONENVIRONMENT = "org.osgi.framework.executionenvironment"
 Framework environment property (named "org.osgi.framework.executionenvironment") identifying execution environments provided by the Framework.
static final String FRAMEWORK_BOOTDELEGATION = "org.osgi.framework.bootdelegation"
 Framework environment property (named "org.osgi.framework.bootdelegation") identifying packages for which the Framework must delegate class loading to the boot class path.
static final String FRAMEWORK_SYSTEMPACKAGES = "org.osgi.framework.system.packages"
 Framework environment property (named "org.osgi.framework.system.packages") identifying package which the system bundle must export.
static final String SUPPORTS_FRAMEWORK_EXTENSION = "org.osgi.supports.framework.extension"
 Framework environment property (named "org.osgi.supports.framework.extension") identifying whether the Framework supports framework extension bundles.
static final String SUPPORTS_BOOTCLASSPATH_EXTENSION = "org.osgi.supports.bootclasspath.extension"
 Framework environment property (named "org.osgi.supports.bootclasspath.extension") identifying whether the Framework supports bootclasspath extension bundles.
static final String SUPPORTS_FRAMEWORK_FRAGMENT = "org.osgi.supports.framework.fragment"
 Framework environment property (named "org.osgi.supports.framework.fragment") identifying whether the Framework supports fragment bundles.
static final String SUPPORTS_FRAMEWORK_REQUIREBUNDLE = "org.osgi.supports.framework.requirebundle"
 Framework environment property (named "org.osgi.supports.framework.requirebundle") identifying whether the Framework supports the Require-Bundle manifest header.
static final String OBJECTCLASS = "objectClass"
 Service property (named "objectClass") identifying all of the class names under which a service was registered in the Framework (of type java.lang.String[]).
static final String SERVICE_ID = "service.id"
 Service property (named "service.id") identifying a service's registration number (of type java.lang.Long).
static final String SERVICE_PID = "service.pid"
 Service property (named "service.pid") identifying a service's persistent identifier.
static final String SERVICE_RANKING = "service.ranking"
 Service property (named "service.ranking") identifying a service's ranking number (of type java.lang.Integer).
static final String SERVICE_VENDOR = "service.vendor"
 Service property (named "service.vendor") identifying a service's vendor.
static final String SERVICE_DESCRIPTION = "service.description"
 Service property (named "service.description") identifying a service's description.
static final String BUNDLE_SYMBOLICNAME = "Bundle-SymbolicName"
 Manifest header (named "Bundle-SymbolicName") identifying the bundle's symbolic name.
static final String SINGLETON_DIRECTIVE = "singleton"
 Manifest header directive (named "singleton") identifying whether a bundle is a singleton.
static final String FRAGMENT_ATTACHMENT_DIRECTIVE = "fragment-attachment"
 Manifest header directive (named "fragment-attachment") identifying if and when a fragment may attach to a host bundle.
static final String FRAGMENT_ATTACHMENT_ALWAYS = "always"
 Manifest header directive value (named "always") identifying a fragment attachment type of always.
static final String FRAGMENT_ATTACHMENT_RESOLVETIME = "resolve-time"
 Manifest header directive value (named "resolve-time") identifying a fragment attachment type of resolve-time.
static final String FRAGMENT_ATTACHMENT_NEVER = "never"
 Manifest header directive value (named "never") identifying a fragment attachment type of never.
static final String BUNDLE_LOCALIZATION = "Bundle-Localization"
 Manifest header (named "Bundle-Localization") identifying the base name of the bundle's localization entries.
static final String BUNDLE_LOCALIZATION_DEFAULT_BASENAME = "OSGI-INF/l10n/bundle"
 Default value for the Bundle-Localization manifest header.
static final String REQUIRE_BUNDLE = "Require-Bundle"
 Manifest header (named "Require-Bundle") identifying the symbolic names of other bundles required by the bundle.
static final String BUNDLE_VERSION_ATTRIBUTE = "bundle-version"
 Manifest header attribute (named "bundle-version") identifying a range of versions for a bundle specified in the Require-Bundle or Fragment-Host manifest headers.
static final String FRAGMENT_HOST = "Fragment-Host"
 Manifest header (named "Fragment-Host") identifying the symbolic name of another bundle for which that the bundle is a fragment.
static final String SELECTION_FILTER_ATTRIBUTE = "selection-filter"
 Manifest header attribute (named "selection-filter") is used for selection by filtering based upon system properties.
static final String BUNDLE_MANIFESTVERSION = "Bundle-ManifestVersion"
 Manifest header (named "Bundle-ManifestVersion") identifying the bundle manifest version.
static final String VERSION_ATTRIBUTE = "version"
 Manifest header attribute (named "version") identifying the version of a package specified in the Export-Package or Import-Package manifest header.
static final String BUNDLE_SYMBOLICNAME_ATTRIBUTE = "bundle-symbolic-name"
 Manifest header attribute (named "bundle-symbolic-name") identifying the symbolic name of a bundle that exports a package specified in the Import-Package manifest header.
static final String RESOLUTION_DIRECTIVE = "resolution"
 Manifest header directive (named "resolution") identifying the resolution type in the Import-Package or Require-Bundle manifest header.
static final String RESOLUTION_MANDATORY = "mandatory"
 Manifest header directive value (named "mandatory") identifying a mandatory resolution type.
static final String RESOLUTION_OPTIONAL = "optional"
 Manifest header directive value (named "optional") identifying an optional resolution type.
static final String USES_DIRECTIVE = "uses"
 Manifest header directive (named "uses") identifying a list of packages that an exported package uses.
static final String INCLUDE_DIRECTIVE = "include"
 Manifest header directive (named "include") identifying a list of classes and/or resources of the specified package which must be allowed to be exported in the Export-Package manifest header.
static final String EXCLUDE_DIRECTIVE = "exclude"
 Manifest header directive (named "exclude") identifying a list of classes and/or resources of the specified package which must not be allowed to be exported in the Export-Package manifest header.
static final String MANDATORY_DIRECTIVE = "mandatory"
 Manifest header directive (named "mandatory") identifying names of matching attributes which must be specified by matching Import-Package statements in the Export-Package manifest header.
static final String VISIBILITY_DIRECTIVE = "visibility"
 Manifest header directive (named "visibility") identifying the visibility of a reqiured bundle in the Require-Bundle manifest header.
static final String VISIBILITY_PRIVATE = "private"
 Manifest header directive value (named "private") identifying a private visibility type.
static final String VISIBILITY_REEXPORT = "reexport"
 Manifest header directive value (named "reexport") identifying a reexport visibility type.
static final String EXTENSION_DIRECTIVE = "extension"
 Manifest header directive (named "extension") identifying the type of the extension fragment.
static final String EXTENSION_FRAMEWORK = "framework"
 Manifest header directive value (named "framework") identifying the type of extension fragment.
static final String EXTENSION_BOOTCLASSPATH = "bootclasspath"
 Manifest header directive value (named "bootclasspath") identifying the type of extension fragment.

Member Data Documentation

final String org.osgi.framework.Constants.SYSTEM_BUNDLE_SYMBOLICNAME = "system.bundle" [static]

Alias for the symbolic name of the OSGi system bundle .

It is defined to be "system.bundle".

Since:
1.3

Definition at line 46 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_CATEGORY = "Bundle-Category" [static]

Manifest header (named "Bundle-Category") identifying the bundle's category.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 55 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_CLASSPATH = "Bundle-ClassPath" [static]

Manifest header (named "Bundle-ClassPath") identifying a list of directories and embedded JAR files, which are bundle resources used to extend the bundle's classpath.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 66 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_COPYRIGHT = "Bundle-Copyright" [static]

Manifest header (named "Bundle-Copyright") identifying the bundle's copyright information.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 75 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_DESCRIPTION = "Bundle-Description" [static]

Manifest header (named "Bundle-Description") containing a brief description of the bundle's functionality.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 84 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NAME = "Bundle-Name" [static]

Manifest header (named "Bundle-Name") identifying the bundle's name.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 93 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NATIVECODE = "Bundle-NativeCode" [static]

Manifest header (named "Bundle-NativeCode") identifying a number of hardware environments and the native language code libraries that the bundle is carrying for each of these environments.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 104 of file Constants.java.

final String org.osgi.framework.Constants.EXPORT_PACKAGE = "Export-Package" [static]

Manifest header (named "Export-Package") identifying the packages that the bundle offers to the Framework for export.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 114 of file Constants.java.

final String org.osgi.framework.Constants.EXPORT_SERVICE = "Export-Service" [static]

Manifest header (named "Export-Service") identifying the fully qualified class names of the services that the bundle may register (used for informational purposes only).

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Deprecated:
As of 1.2.

Definition at line 127 of file Constants.java.

final String org.osgi.framework.Constants.IMPORT_PACKAGE = "Import-Package" [static]

Manifest header (named "Import-Package") identifying the packages on which the bundle depends.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 137 of file Constants.java.

final String org.osgi.framework.Constants.DYNAMICIMPORT_PACKAGE = "DynamicImport-Package" [static]

Manifest header (named "DynamicImport-Package") identifying the packages that the bundle may dynamically import during execution.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.2

Definition at line 149 of file Constants.java.

final String org.osgi.framework.Constants.IMPORT_SERVICE = "Import-Service" [static]

Manifest header (named "Import-Service") identifying the fully qualified class names of the services that the bundle requires (used for informational purposes only).

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Deprecated:
As of 1.2.

Definition at line 162 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_VENDOR = "Bundle-Vendor" [static]

Manifest header (named "Bundle-Vendor") identifying the bundle's vendor.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 172 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_VERSION = "Bundle-Version" [static]

Manifest header (named "Bundle-Version") identifying the bundle's version.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 182 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_DOCURL = "Bundle-DocURL" [static]

Manifest header (named "Bundle-DocURL") identifying the bundle's documentation URL, from which further information about the bundle may be obtained.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 193 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_CONTACTADDRESS = "Bundle-ContactAddress" [static]

Manifest header (named "Bundle-ContactAddress") identifying the contact address where problems with the bundle may be reported; for example, an email address.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 204 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_ACTIVATOR = "Bundle-Activator" [static]

Manifest header attribute (named "Bundle-Activator") identifying the bundle's activator class.

If present, this header specifies the name of the bundle resource class that implements the BundleActivator interface and whose start and stop methods are called by the Framework when the bundle is started and stopped, respectively.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 220 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_UPDATELOCATION = "Bundle-UpdateLocation" [static]

Manifest header (named "Bundle-UpdateLocation") identifying the location from which a new bundle version is obtained during a bundle update operation.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Definition at line 231 of file Constants.java.

final String org.osgi.framework.Constants.PACKAGE_SPECIFICATION_VERSION = "specification-version" [static]

Manifest header attribute (named "specification-version") identifying the version of a package specified in the Export-Package or Import-Package manifest header.

The attribute value is encoded in the Export-Package or Import-Package manifest header like:

   Import-Package: org.osgi.framework ; specification-version="1.1"
 

Deprecated:
As of 1.3. This has been replaced by VERSION_ATTRIBUTE.

Definition at line 249 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NATIVECODE_PROCESSOR = "processor" [static]

Manifest header attribute (named "processor") identifying the processor required to run native bundle code specified in the Bundle-NativeCode manifest header).

The attribute value is encoded in the Bundle-NativeCode manifest header like:

   Bundle-NativeCode: http.so ; processor=x86 ...
 

Definition at line 264 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NATIVECODE_OSNAME = "osname" [static]

Manifest header attribute (named "osname") identifying the operating system required to run native bundle code specified in the Bundle-NativeCode manifest header).

The attribute value is encoded in the Bundle-NativeCode manifest header like:

   Bundle-NativeCode: http.so ; osname=Linux ...
 

Definition at line 278 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NATIVECODE_OSVERSION = "osversion" [static]

Manifest header attribute (named "osversion") identifying the operating system version required to run native bundle code specified in the Bundle-NativeCode manifest header).

The attribute value is encoded in the Bundle-NativeCode manifest header like:

   Bundle-NativeCode: http.so ; osversion="2.34" ...
 

Definition at line 292 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_NATIVECODE_LANGUAGE = "language" [static]

Manifest header attribute (named "language") identifying the language in which the native bundle code is written specified in the Bundle-NativeCode manifest header.

See ISO 639 for possible values.

The attribute value is encoded in the Bundle-NativeCode manifest header like:

   Bundle-NativeCode: http.so ; language=nl_be ...
 

Definition at line 306 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_REQUIREDEXECUTIONENVIRONMENT = "Bundle-RequiredExecutionEnvironment" [static]

Manifest header (named "Bundle-RequiredExecutionEnvironment") identifying the required execution environment for the bundle.

The service platform may run this bundle if any of the execution environments named in this header matches one of the execution environments it implements.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.2

Definition at line 321 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_VERSION = "org.osgi.framework.version" [static]

Framework environment property (named "org.osgi.framework.version") identifying the Framework version.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 336 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_VENDOR = "org.osgi.framework.vendor" [static]

Framework environment property (named "org.osgi.framework.vendor") identifying the Framework implementation vendor.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 347 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_LANGUAGE = "org.osgi.framework.language" [static]

Framework environment property (named "org.osgi.framework.language") identifying the Framework implementation language (see ISO 639 for possible values).

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 358 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_OS_NAME = "org.osgi.framework.os.name" [static]

Framework environment property (named "org.osgi.framework.os.name") identifying the Framework host-computer's operating system.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 369 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_OS_VERSION = "org.osgi.framework.os.version" [static]

Framework environment property (named "org.osgi.framework.os.version") identifying the Framework host-computer's operating system version number.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 380 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_PROCESSOR = "org.osgi.framework.processor" [static]

Framework environment property (named "org.osgi.framework.processor") identifying the Framework host-computer's processor name.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Definition at line 390 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_EXECUTIONENVIRONMENT = "org.osgi.framework.executionenvironment" [static]

Framework environment property (named "org.osgi.framework.executionenvironment") identifying execution environments provided by the Framework.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.2

Definition at line 402 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_BOOTDELEGATION = "org.osgi.framework.bootdelegation" [static]

Framework environment property (named "org.osgi.framework.bootdelegation") identifying packages for which the Framework must delegate class loading to the boot class path.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 414 of file Constants.java.

final String org.osgi.framework.Constants.FRAMEWORK_SYSTEMPACKAGES = "org.osgi.framework.system.packages" [static]

Framework environment property (named "org.osgi.framework.system.packages") identifying package which the system bundle must export.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 426 of file Constants.java.

final String org.osgi.framework.Constants.SUPPORTS_FRAMEWORK_EXTENSION = "org.osgi.supports.framework.extension" [static]

Framework environment property (named "org.osgi.supports.framework.extension") identifying whether the Framework supports framework extension bundles.

If the value of this property is true, then the Framework supports framework extension bundles. The default value is false.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 440 of file Constants.java.

final String org.osgi.framework.Constants.SUPPORTS_BOOTCLASSPATH_EXTENSION = "org.osgi.supports.bootclasspath.extension" [static]

Framework environment property (named "org.osgi.supports.bootclasspath.extension") identifying whether the Framework supports bootclasspath extension bundles.

If the value of this property is true, then the Framework supports bootclasspath extension bundles. The default value is false.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 455 of file Constants.java.

final String org.osgi.framework.Constants.SUPPORTS_FRAMEWORK_FRAGMENT = "org.osgi.supports.framework.fragment" [static]

Framework environment property (named "org.osgi.supports.framework.fragment") identifying whether the Framework supports fragment bundles.

If the value of this property is true, then the Framework supports fragment bundles. The default value is false.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 469 of file Constants.java.

final String org.osgi.framework.Constants.SUPPORTS_FRAMEWORK_REQUIREBUNDLE = "org.osgi.supports.framework.requirebundle" [static]

Framework environment property (named "org.osgi.supports.framework.requirebundle") identifying whether the Framework supports the Require-Bundle manifest header.

If the value of this property is true, then the Framework supports the Require-Bundle manifest header. The default value is false.

The value of this property may be retrieved by calling the BundleContext.getProperty method.

Since:
1.3

Definition at line 484 of file Constants.java.

final String org.osgi.framework.Constants.OBJECTCLASS = "objectClass" [static]

Service property (named "objectClass") identifying all of the class names under which a service was registered in the Framework (of type java.lang.String[]).

This property is set by the Framework when a service is registered.

Definition at line 498 of file Constants.java.

final String org.osgi.framework.Constants.SERVICE_ID = "service.id" [static]

Service property (named "service.id") identifying a service's registration number (of type java.lang.Long).

The value of this property is assigned by the Framework when a service is registered. The Framework assigns a unique value that is larger than all previously assigned values since the Framework was started. These values are NOT persistent across restarts of the Framework.

Definition at line 510 of file Constants.java.

final String org.osgi.framework.Constants.SERVICE_PID = "service.pid" [static]

Service property (named "service.pid") identifying a service's persistent identifier.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

A service's persistent identifier uniquely identifies the service and persists across multiple Framework invocations.

By convention, every bundle has its own unique namespace, starting with the bundle's identifier (see Bundle#getBundleId) and followed by a dot (.). A bundle may use this as the prefix of the persistent identifiers for the services it registers.

Definition at line 531 of file Constants.java.

final String org.osgi.framework.Constants.SERVICE_RANKING = "service.ranking" [static]

Service property (named "service.ranking") identifying a service's ranking number (of type java.lang.Integer).

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

The service ranking is used by the Framework to determine the default service to be returned from a call to the BundleContext#getServiceReference method: If more than one service implements the specified class, the ServiceReference object with the highest ranking is returned.

The default ranking is zero (0). A service with a ranking of Integer.MAX_VALUE is very likely to be returned as the default service, whereas a service with a ranking of Integer.MIN_VALUE is very unlikely to be returned.

If the supplied property value is not of type java.lang.Integer, it is deemed to have a ranking value of zero.

Definition at line 560 of file Constants.java.

final String org.osgi.framework.Constants.SERVICE_VENDOR = "service.vendor" [static]

Service property (named "service.vendor") identifying a service's vendor.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

Definition at line 570 of file Constants.java.

final String org.osgi.framework.Constants.SERVICE_DESCRIPTION = "service.description" [static]

Service property (named "service.description") identifying a service's description.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

Definition at line 580 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_SYMBOLICNAME = "Bundle-SymbolicName" [static]

Manifest header (named "Bundle-SymbolicName") identifying the bundle's symbolic name.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.3

Definition at line 591 of file Constants.java.

final String org.osgi.framework.Constants.SINGLETON_DIRECTIVE = "singleton" [static]

Manifest header directive (named "singleton") identifying whether a bundle is a singleton.

The default value is false.

The directive value is encoded in the Bundle-SymbolicName manifest header like:

   Bundle-SymbolicName: com.acme.module.test; singleton:=true
 

Since:
1.3

Definition at line 607 of file Constants.java.

final String org.osgi.framework.Constants.FRAGMENT_ATTACHMENT_DIRECTIVE = "fragment-attachment" [static]

Manifest header directive (named "fragment-attachment") identifying if and when a fragment may attach to a host bundle.

The default value is "always".

The directive value is encoded in the Bundle-SymbolicName manifest header like:

   Bundle-SymbolicName: com.acme.module.test; fragment-attachment:="never"
 

See also:
Constants.FRAGMENT_ATTACHMENT_ALWAYS

Constants.FRAGMENT_ATTACHMENT_RESOLVETIME

Constants.FRAGMENT_ATTACHMENT_NEVER

Since:
1.3

Definition at line 627 of file Constants.java.

final String org.osgi.framework.Constants.FRAGMENT_ATTACHMENT_ALWAYS = "always" [static]

Manifest header directive value (named "always") identifying a fragment attachment type of always.

A fragment attachment type of always indicates that fragments are allowed to attach to the host bundle at any time (while the host is resolved or during the process of resolving the host bundle).

The directive value is encoded in the Bundle-SymbolicName manifest header like:

   Bundle-SymbolicName: com.acme.module.test; fragment-attachment:="always"
 

See also:
Constants.FRAGMENT_ATTACHMENT_DIRECTIVE
Since:
1.3

Definition at line 647 of file Constants.java.

final String org.osgi.framework.Constants.FRAGMENT_ATTACHMENT_RESOLVETIME = "resolve-time" [static]

Manifest header directive value (named "resolve-time") identifying a fragment attachment type of resolve-time.

A fragment attachment type of resolve-time indicates that fragments are allowed to attach to the host bundle only during the process of resolving the host bundle.

The directive value is encoded in the Bundle-SymbolicName manifest header like:

   Bundle-SymbolicName: com.acme.module.test; fragment-attachment:="resolve-time"
 

See also:
Constants.FRAGMENT_ATTACHMENT_DIRECTIVE
Since:
1.3

Definition at line 667 of file Constants.java.

final String org.osgi.framework.Constants.FRAGMENT_ATTACHMENT_NEVER = "never" [static]

Manifest header directive value (named "never") identifying a fragment attachment type of never.

A fragment attachment type of never indicates that no fragments are allowed to attach to the host bundle at any time.

The directive value is encoded in the Bundle-SymbolicName manifest header like:

   Bundle-SymbolicName: com.acme.module.test; fragment-attachment:="never"
 

See also:
Constants.FRAGMENT_ATTACHMENT_DIRECTIVE
Since:
1.3

Definition at line 686 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_LOCALIZATION = "Bundle-Localization" [static]

Manifest header (named "Bundle-Localization") identifying the base name of the bundle's localization entries.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

See also:
BUNDLE_LOCALIZATION_DEFAULT_BASENAME
Since:
1.3

Definition at line 698 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_LOCALIZATION_DEFAULT_BASENAME = "OSGI-INF/l10n/bundle" [static]

Default value for the Bundle-Localization manifest header.

See also:
BUNDLE_LOCALIZATION
Since:
1.3

Definition at line 706 of file Constants.java.

final String org.osgi.framework.Constants.REQUIRE_BUNDLE = "Require-Bundle" [static]

Manifest header (named "Require-Bundle") identifying the symbolic names of other bundles required by the bundle.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.3

Definition at line 718 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_VERSION_ATTRIBUTE = "bundle-version" [static]

Manifest header attribute (named "bundle-version") identifying a range of versions for a bundle specified in the Require-Bundle or Fragment-Host manifest headers.

The default value is 0.0.0.

The attribute value is encoded in the Require-Bundle manifest header like:

   Require-Bundle: com.acme.module.test; bundle-version="1.1"
   Require-Bundle: com.acme.module.test; bundle-version="[1.0,2.0)"
 

The bundle-version attribute value uses a mathematical interval notation to specify a range of bundle versions. A bundle-version attribute value specified as a single version means a version range that includes any bundle version greater than or equal to the specified version.

Since:
1.3

Definition at line 742 of file Constants.java.

final String org.osgi.framework.Constants.FRAGMENT_HOST = "Fragment-Host" [static]

Manifest header (named "Fragment-Host") identifying the symbolic name of another bundle for which that the bundle is a fragment.

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.3

Definition at line 754 of file Constants.java.

final String org.osgi.framework.Constants.SELECTION_FILTER_ATTRIBUTE = "selection-filter" [static]

Manifest header attribute (named "selection-filter") is used for selection by filtering based upon system properties.

The attribute value is encoded in manifest headers like:

   Bundle-NativeCode: libgtk.so; selection-filter="(ws=gtk)"; ...
 

Since:
1.3

Definition at line 769 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_MANIFESTVERSION = "Bundle-ManifestVersion" [static]

Manifest header (named "Bundle-ManifestVersion") identifying the bundle manifest version.

A bundle manifest may express the version of the syntax in which it is written by specifying a bundle manifest version. Bundles exploiting OSGi R4, or later, syntax must specify a bundle manifest version.

The bundle manifest version defined by OSGi R4 or, more specifically, by V1.3 of the OSGi Framework Specification is "2".

The attribute value may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.

Since:
1.3

Definition at line 787 of file Constants.java.

final String org.osgi.framework.Constants.VERSION_ATTRIBUTE = "version" [static]

Manifest header attribute (named "version") identifying the version of a package specified in the Export-Package or Import-Package manifest header.

The attribute value is encoded in the Export-Package or Import-Package manifest header like:

   Import-Package: org.osgi.framework; version="1.1"
 

Since:
1.3

Definition at line 804 of file Constants.java.

final String org.osgi.framework.Constants.BUNDLE_SYMBOLICNAME_ATTRIBUTE = "bundle-symbolic-name" [static]

Manifest header attribute (named "bundle-symbolic-name") identifying the symbolic name of a bundle that exports a package specified in the Import-Package manifest header.

The attribute value is encoded in the Import-Package manifest header like:

   Import-Package: org.osgi.framework; bundle-symbolic-name="com.acme.module.test"
 

Since:
1.3

Definition at line 821 of file Constants.java.

final String org.osgi.framework.Constants.RESOLUTION_DIRECTIVE = "resolution" [static]

Manifest header directive (named "resolution") identifying the resolution type in the Import-Package or Require-Bundle manifest header.

The directive value is encoded in the Import-Package or Require-Bundle manifest header like:

   Import-Package: org.osgi.framework; resolution:="optional"
   Require-Bundle: com.acme.module.test; resolution:="optional"
 

See also:
Constants.RESOLUTION_MANDATORY

Constants.RESOLUTION_OPTIONAL

Since:
1.3

Definition at line 840 of file Constants.java.

final String org.osgi.framework.Constants.RESOLUTION_MANDATORY = "mandatory" [static]

Manifest header directive value (named "mandatory") identifying a mandatory resolution type.

A mandatory resolution type indicates that the import package or require bundle must be resolved when the bundle is resolved. If such an import or require bundle cannot be resolved, the module fails to resolve.

The directive value is encoded in the Import-Package or Require-Bundle manifest header like:

   Import-Package: org.osgi.framework; resolution:="manditory"
   Require-Bundle: com.acme.module.test; resolution:="manditory"
 

See also:
Constants.RESOLUTION_DIRECTIVE
Since:
1.3

Definition at line 861 of file Constants.java.

final String org.osgi.framework.Constants.RESOLUTION_OPTIONAL = "optional" [static]

Manifest header directive value (named "optional") identifying an optional resolution type.

An optional resolution type indicates that the import or require bundle is optional and the bundle may be resolved without the import or require bundle being resolved. If the import or require bundle is not resolved when the bundle is resolved, the import or require bundle may not be resolved before the bundle is refreshed.

The directive value is encoded in the Import-Package or Require-Bundle manifest header like:

   Import-Package: org.osgi.framework; resolution:="optional"
   Require-Bundle: com.acme.module.test; resolution:="optional"
 

See also:
Constants.RESOLUTION_DIRECTIVE
Since:
1.3

Definition at line 883 of file Constants.java.

final String org.osgi.framework.Constants.USES_DIRECTIVE = "uses" [static]

Manifest header directive (named "uses") identifying a list of packages that an exported package uses.

The directive value is encoded in the Export-Package manifest header like:

   Export-Package: org.osgi.util.tracker; uses:="org.osgi.framework"
 

Since:
1.3

Definition at line 899 of file Constants.java.

final String org.osgi.framework.Constants.INCLUDE_DIRECTIVE = "include" [static]

Manifest header directive (named "include") identifying a list of classes and/or resources of the specified package which must be allowed to be exported in the Export-Package manifest header.

The directive value is encoded in the Export-Package manifest header like:

   Export-Package: org.osgi.framework; include:="MyStuff*"
 

Since:
1.3

Definition at line 916 of file Constants.java.

final String org.osgi.framework.Constants.EXCLUDE_DIRECTIVE = "exclude" [static]

Manifest header directive (named "exclude") identifying a list of classes and/or resources of the specified package which must not be allowed to be exported in the Export-Package manifest header.

The directive value is encoded in the Export-Package manifest header like:

   Export-Package: org.osgi.framework; exclude:="MyStuff*"
 

Since:
1.3

Definition at line 933 of file Constants.java.

final String org.osgi.framework.Constants.MANDATORY_DIRECTIVE = "mandatory" [static]

Manifest header directive (named "mandatory") identifying names of matching attributes which must be specified by matching Import-Package statements in the Export-Package manifest header.

The directive value is encoded in the Export-Package manifest header like:

   Export-Package: org.osgi.framework; mandatory:="bundle-symbolic-name"
 

Since:
1.3

Definition at line 950 of file Constants.java.

final String org.osgi.framework.Constants.VISIBILITY_DIRECTIVE = "visibility" [static]

Manifest header directive (named "visibility") identifying the visibility of a reqiured bundle in the Require-Bundle manifest header.

The directive value is encoded in the Require-Bundle manifest header like:

   Require-Bundle: com.acme.module.test; visibility:="reexport"
 

See also:
Constants.VISIBILITY_PRIVATE

Constants.VISIBILITY_REEXPORT

Since:
1.3

Definition at line 968 of file Constants.java.

final String org.osgi.framework.Constants.VISIBILITY_PRIVATE = "private" [static]

Manifest header directive value (named "private") 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.

The directive value is encoded in the Require-Bundle manifest header like:

   Require-Bundle: com.acme.module.test; visibility:="private"
 

See also:
Constants.VISIBILITY_DIRECTIVE
Since:
1.3

Definition at line 987 of file Constants.java.

final String org.osgi.framework.Constants.VISIBILITY_REEXPORT = "reexport" [static]

Manifest header directive value (named "reexport") 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. Any arbitrary arbitrary matching attributes with which they were exported by the required bundle are deleted.

The directive value is encoded in the Require-Bundle manifest header like:

   Require-Bundle: com.acme.module.test; visibility:="reexport"
 

See also:
Constants.VISIBILITY_DIRECTIVE
Since:
1.3

Definition at line 1007 of file Constants.java.

final String org.osgi.framework.Constants.EXTENSION_DIRECTIVE = "extension" [static]

Manifest header directive (named "extension") identifying the type of the extension fragment.

The directive value is encoded in the Fragment-Host manifest header like:

   Fragment-Host: system.bundle; extension:="framework"
 

See also:
Constants.EXTENSION_FRAMEWORK

Constants.EXTENSION_BOOTCLASSPATH

Since:
1.3

Definition at line 1024 of file Constants.java.

final String org.osgi.framework.Constants.EXTENSION_FRAMEWORK = "framework" [static]

Manifest header directive value (named "framework") identifying the type of extension fragment.

An extension fragment type of framework indicates that the extension fragment is to be loaded by the framework's class loader.

The directive value is encoded in the Fragment-Host manifest header like:

   Fragment-Host: system.bundle; extension:="framework"
 

See also:
Constants.EXTENSION_DIRECTIVE
Since:
1.3

Definition at line 1043 of file Constants.java.

final String org.osgi.framework.Constants.EXTENSION_BOOTCLASSPATH = "bootclasspath" [static]

Manifest header directive value (named "bootclasspath") identifying the type of extension fragment.

An extension fragment type of bootclasspath indicates that the extension fragment is to be loaded by the boot class loader.

The directive value is encoded in the Fragment-Host manifest header like:

   Fragment-Host: system.bundle; extension:="bootclasspath"
 

See also:
Constants.EXTENSION_DIRECTIVE
Since:
1.3

Definition at line 1062 of file Constants.java.


The documentation for this interface was generated from the following file:
Generated on Mon Jan 11 21:19:24 2010 for OpenMobileIS by  doxygen 1.5.4