org.osgi.framework
Interface Constants

public interface Constants

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

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

Since:

1.1

Field Summary

static java.lang.String	ACTIVATION_LAZY Bundle activation policy declaring the bundle must be activated when the first class load is made from the bundle.
static java.lang.String	BUNDLE_ACTIVATIONPOLICY Manifest header identifying the bundle's activation policy.
static java.lang.String	BUNDLE_ACTIVATOR Manifest header attribute identifying the bundle's activator class.
static java.lang.String	BUNDLE_CATEGORY Manifest header identifying the bundle's category.
static java.lang.String	BUNDLE_CLASSPATH Manifest header identifying a list of directories and embedded JAR files, which are bundle resources used to extend the bundle's classpath.
static java.lang.String	BUNDLE_CONTACTADDRESS Manifest header identifying the contact address where problems with the bundle may be reported; for example, an email address.
static java.lang.String	BUNDLE_COPYRIGHT Manifest header identifying the bundle's copyright information.
static java.lang.String	BUNDLE_DESCRIPTION Manifest header containing a brief description of the bundle's functionality.
static java.lang.String	BUNDLE_DOCURL Manifest header identifying the bundle's documentation URL, from which further information about the bundle may be obtained.
static java.lang.String	BUNDLE_LOCALIZATION Manifest header identifying the base name of the bundle's localization entries.
static java.lang.String	BUNDLE_LOCALIZATION_DEFAULT_BASENAME Default value for the Bundle-Localization manifest header.
static java.lang.String	BUNDLE_MANIFESTVERSION Manifest header identifying the bundle manifest version.
static java.lang.String	BUNDLE_NAME Manifest header identifying the bundle's name.
static java.lang.String	BUNDLE_NATIVECODE Manifest header identifying a number of hardware environments and the native language code libraries that the bundle is carrying for each of these environments.
static java.lang.String	BUNDLE_NATIVECODE_LANGUAGE Manifest header attribute identifying the language in which the native bundle code is written specified in the Bundle-NativeCode manifest header.
static java.lang.String	BUNDLE_NATIVECODE_OSNAME Manifest header attribute identifying the operating system required to run native bundle code specified in the Bundle-NativeCode manifest header).
static java.lang.String	BUNDLE_NATIVECODE_OSVERSION Manifest header attribute identifying the operating system version required to run native bundle code specified in the Bundle-NativeCode manifest header).
static java.lang.String	BUNDLE_NATIVECODE_PROCESSOR Manifest header attribute identifying the processor required to run native bundle code specified in the Bundle-NativeCode manifest header).
static java.lang.String	BUNDLE_REQUIREDEXECUTIONENVIRONMENT Manifest header identifying the required execution environment for the bundle.
static java.lang.String	BUNDLE_SYMBOLICNAME Manifest header identifying the bundle's symbolic name.
static java.lang.String	BUNDLE_SYMBOLICNAME_ATTRIBUTE Manifest header attribute identifying the symbolic name of a bundle that exports a package specified in the Import-Package manifest header.
static java.lang.String	BUNDLE_UPDATELOCATION Manifest header identifying the location from which a new bundle version is obtained during a bundle update operation.
static java.lang.String	BUNDLE_VENDOR Manifest header identifying the bundle's vendor.
static java.lang.String	BUNDLE_VERSION Manifest header identifying the bundle's version.
static java.lang.String	BUNDLE_VERSION_ATTRIBUTE Manifest header attribute identifying a range of versions for a bundle specified in the Require-Bundle or Fragment-Host manifest headers.
static java.lang.String	DYNAMICIMPORT_PACKAGE Manifest header identifying the packages that the bundle may dynamically import during execution.
static java.lang.String	EXCLUDE_DIRECTIVE Manifest header directive identifying a list of classes to exclude in the exported package..
static java.lang.String	EXPORT_PACKAGE Manifest header identifying the packages that the bundle offers to the Framework for export.
static java.lang.String	EXPORT_SERVICE Deprecated. As of 1.2.
static java.lang.String	EXTENSION_BOOTCLASSPATH Manifest header directive value identifying the type of extension fragment.
static java.lang.String	EXTENSION_DIRECTIVE Manifest header directive identifying the type of the extension fragment.
static java.lang.String	EXTENSION_FRAMEWORK Manifest header directive value identifying the type of extension fragment.
static java.lang.String	FRAGMENT_ATTACHMENT_ALWAYS Manifest header directive value identifying a fragment attachment type of always.
static java.lang.String	FRAGMENT_ATTACHMENT_DIRECTIVE Manifest header directive identifying if and when a fragment may attach to a host bundle.
static java.lang.String	FRAGMENT_ATTACHMENT_NEVER Manifest header directive value identifying a fragment attachment type of never.
static java.lang.String	FRAGMENT_ATTACHMENT_RESOLVETIME Manifest header directive value identifying a fragment attachment type of resolve-time.
static java.lang.String	FRAGMENT_HOST Manifest header identifying the symbolic name of another bundle for which that the bundle is a fragment.
static java.lang.String	FRAMEWORK_BEGINNING_STARTLEVEL Specifies the beginning start level of the framework.
static java.lang.String	FRAMEWORK_BOOTDELEGATION Framework environment property identifying packages for which the Framework must delegate class loading to the parent class loader of the bundle.
static java.lang.String	FRAMEWORK_BUNDLE_PARENT Specifies the parent class loader type for all bundle class loaders.
static java.lang.String	FRAMEWORK_BUNDLE_PARENT_APP Specifies to use the application class loader as the parent class loader for all bundle class loaders.
static java.lang.String	FRAMEWORK_BUNDLE_PARENT_BOOT Specifies to use of the boot class loader as the parent class loader for all bundle class loaders.
static java.lang.String	FRAMEWORK_BUNDLE_PARENT_EXT Specifies to use the extension class loader as the parent class loader for all bundle class loaders.
static java.lang.String	FRAMEWORK_BUNDLE_PARENT_FRAMEWORK Specifies to use the framework class loader as the parent class loader for all bundle class loaders.
static java.lang.String	FRAMEWORK_EXECPERMISSION Specifies an optional OS specific command to set file permissions on extracted native code.
static java.lang.String	FRAMEWORK_EXECUTIONENVIRONMENT Framework environment property identifying execution environments provided by the Framework.
static java.lang.String	FRAMEWORK_LANGUAGE Framework environment property identifying the Framework implementation language (see ISO 639 for possible values).
static java.lang.String	FRAMEWORK_LIBRARY_EXTENSIONS Specifies a comma separated list of additional library file extensions that must be used when a bundle's class loader is searching for native libraries.
static java.lang.String	FRAMEWORK_OS_NAME Framework environment property identifying the Framework host-computer's operating system.
static java.lang.String	FRAMEWORK_OS_VERSION Framework environment property identifying the Framework host-computer's operating system version number.
static java.lang.String	FRAMEWORK_PROCESSOR Framework environment property identifying the Framework host-computer's processor name.
static java.lang.String	FRAMEWORK_SECURITY Specifies the type of security manager the framework must use.
static java.lang.String	FRAMEWORK_SECURITY_OSGI Specifies that a security manager that supports all security aspects of the OSGi core specification including postponed conditions must be installed.
static java.lang.String	FRAMEWORK_STORAGE Specified the persistent storage area used by the framework.
static java.lang.String	FRAMEWORK_STORAGE_CLEAN Specifies if and when the persistent storage area for the framework should be cleaned.
static java.lang.String	FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT Specifies that the framework storage area must be cleaned before the framework is initialized for the first time.
static java.lang.String	FRAMEWORK_SYSTEMPACKAGES Framework environment property identifying packages which the system bundle must export.
static java.lang.String	FRAMEWORK_SYSTEMPACKAGES_EXTRA Framework environment property identifying extra packages which the system bundle must export from the current execution environment.
static java.lang.String	FRAMEWORK_TRUST_REPOSITORIES Specifies the trust repositories used by the framework.
static java.lang.String	FRAMEWORK_VENDOR Framework environment property identifying the Framework implementation vendor.
static java.lang.String	FRAMEWORK_VERSION Framework environment property identifying the Framework version.
static java.lang.String	FRAMEWORK_WINDOWSYSTEM Specifies the current windowing system.
static java.lang.String	IMPORT_PACKAGE Manifest header identifying the packages on which the bundle depends.
static java.lang.String	IMPORT_SERVICE Deprecated. As of 1.2.
static java.lang.String	INCLUDE_DIRECTIVE Manifest header directive identifying a list of classes to include in the exported package.
static java.lang.String	MANDATORY_DIRECTIVE Manifest header directive identifying names of matching attributes which must be specified by matching Import-Package statements in the Export-Package manifest header.
static java.lang.String	OBJECTCLASS Service property identifying all of the class names under which a service was registered in the Framework.
static java.lang.String	PACKAGE_SPECIFICATION_VERSION Deprecated. As of 1.3. This has been replaced by VERSION_ATTRIBUTE.
static java.lang.String	REQUIRE_BUNDLE Manifest header identifying the symbolic names of other bundles required by the bundle.
static java.lang.String	RESOLUTION_DIRECTIVE Manifest header directive identifying the resolution type in the Import-Package or Require-Bundle manifest header.
static java.lang.String	RESOLUTION_MANDATORY Manifest header directive value identifying a mandatory resolution type.
static java.lang.String	RESOLUTION_OPTIONAL Manifest header directive value identifying an optional resolution type.
static java.lang.String	SELECTION_FILTER_ATTRIBUTE Manifest header attribute is used for selection by filtering based upon system properties.
static java.lang.String	SERVICE_DESCRIPTION Service property identifying a service's description.
static java.lang.String	SERVICE_ID Service property identifying a service's registration number.
static java.lang.String	SERVICE_PID Service property identifying a service's persistent identifier.
static java.lang.String	SERVICE_RANKING Service property identifying a service's ranking number.
static java.lang.String	SERVICE_VENDOR Service property identifying a service's vendor.
static java.lang.String	SINGLETON_DIRECTIVE Manifest header directive identifying whether a bundle is a singleton.
static java.lang.String	SUPPORTS_BOOTCLASSPATH_EXTENSION Framework environment property identifying whether the Framework supports bootclasspath extension bundles.
static java.lang.String	SUPPORTS_FRAMEWORK_EXTENSION Framework environment property identifying whether the Framework supports framework extension bundles.
static java.lang.String	SUPPORTS_FRAMEWORK_FRAGMENT Framework environment property identifying whether the Framework supports fragment bundles.
static java.lang.String	SUPPORTS_FRAMEWORK_REQUIREBUNDLE Framework environment property identifying whether the Framework supports the Require-Bundle manifest header.
static java.lang.String	SYSTEM_BUNDLE_LOCATION Location identifier of the OSGi system bundle , which is defined to be "System Bundle".
static java.lang.String	SYSTEM_BUNDLE_SYMBOLICNAME Alias for the symbolic name of the OSGi system bundle .
static java.lang.String	USES_DIRECTIVE Manifest header directive identifying a list of packages that an exported package uses.
static java.lang.String	VERSION_ATTRIBUTE Manifest header attribute identifying the version of a package specified in the Export-Package or Import-Package manifest header.
static java.lang.String	VISIBILITY_DIRECTIVE Manifest header directive identifying the visibility of a required bundle in the Require-Bundle manifest header.
static java.lang.String	VISIBILITY_PRIVATE Manifest header directive value identifying a private visibility type.
static java.lang.String	VISIBILITY_REEXPORT Manifest header directive value identifying a reexport visibility type.

Field Detail

SYSTEM_BUNDLE_LOCATION

static final java.lang.String SYSTEM_BUNDLE_LOCATION

Location identifier of the OSGi system bundle , which is defined to be "System Bundle".

See Also:

Constant Field Values

SYSTEM_BUNDLE_SYMBOLICNAME

static final java.lang.String SYSTEM_BUNDLE_SYMBOLICNAME

Alias for the symbolic name of the OSGi system bundle . It is defined to be "system.bundle".

Since:

1.3

See Also:

Constant Field Values

BUNDLE_CATEGORY

static final java.lang.String BUNDLE_CATEGORY

Manifest header identifying the bundle's category.

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

See Also:

Constant Field Values

BUNDLE_CLASSPATH

static final java.lang.String BUNDLE_CLASSPATH

Manifest header 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.

See Also:

Constant Field Values

BUNDLE_COPYRIGHT

static final java.lang.String BUNDLE_COPYRIGHT

Manifest header identifying the bundle's copyright information.

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

See Also:

Constant Field Values

BUNDLE_DESCRIPTION

static final java.lang.String BUNDLE_DESCRIPTION

Manifest header 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.

See Also:

Constant Field Values

BUNDLE_NAME

static final java.lang.String BUNDLE_NAME

Manifest header identifying the bundle's name.

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE

static final java.lang.String BUNDLE_NATIVECODE

Manifest header 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.

See Also:

Constant Field Values

EXPORT_PACKAGE

static final java.lang.String EXPORT_PACKAGE

Manifest header 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.

See Also:

Constant Field Values

EXPORT_SERVICE

static final java.lang.String EXPORT_SERVICE

Deprecated. As of 1.2.

Manifest header 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.

See Also:

Constant Field Values

IMPORT_PACKAGE

static final java.lang.String IMPORT_PACKAGE

Manifest header identifying the packages on which the bundle depends.

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

See Also:

Constant Field Values

DYNAMICIMPORT_PACKAGE

static final java.lang.String DYNAMICIMPORT_PACKAGE

Manifest header 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

See Also:

Constant Field Values

IMPORT_SERVICE

static final java.lang.String IMPORT_SERVICE

Deprecated. As of 1.2.

Manifest header 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.

See Also:

Constant Field Values

BUNDLE_VENDOR

static final java.lang.String BUNDLE_VENDOR

Manifest header identifying the bundle's vendor.

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

See Also:

Constant Field Values

BUNDLE_VERSION

static final java.lang.String BUNDLE_VERSION

Manifest header identifying the bundle's version.

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

See Also:

Constant Field Values

BUNDLE_DOCURL

static final java.lang.String BUNDLE_DOCURL

Manifest header 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.

See Also:

Constant Field Values

BUNDLE_CONTACTADDRESS

static final java.lang.String BUNDLE_CONTACTADDRESS

Manifest header 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.

See Also:

Constant Field Values

BUNDLE_ACTIVATOR

static final java.lang.String BUNDLE_ACTIVATOR

Manifest header attribute 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.

See Also:

Constant Field Values

BUNDLE_UPDATELOCATION

static final java.lang.String BUNDLE_UPDATELOCATION

Manifest header 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.

See Also:

Constant Field Values

PACKAGE_SPECIFICATION_VERSION

static final java.lang.String PACKAGE_SPECIFICATION_VERSION

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE_PROCESSOR

static final java.lang.String BUNDLE_NATIVECODE_PROCESSOR

Manifest header attribute 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 ...
 

See Also:

BUNDLE_NATIVECODE, Constant Field Values

BUNDLE_NATIVECODE_OSNAME

static final java.lang.String BUNDLE_NATIVECODE_OSNAME

Manifest header attribute 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 ...
 

See Also:

BUNDLE_NATIVECODE, Constant Field Values

BUNDLE_NATIVECODE_OSVERSION

static final java.lang.String BUNDLE_NATIVECODE_OSVERSION

Manifest header attribute 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" ...
 

See Also:

BUNDLE_NATIVECODE, Constant Field Values

BUNDLE_NATIVECODE_LANGUAGE

static final java.lang.String BUNDLE_NATIVECODE_LANGUAGE

Manifest header attribute 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 ...
 

See Also:

BUNDLE_NATIVECODE, Constant Field Values

BUNDLE_REQUIREDEXECUTIONENVIRONMENT

static final java.lang.String BUNDLE_REQUIREDEXECUTIONENVIRONMENT

Manifest header 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

See Also:

Constant Field Values

BUNDLE_SYMBOLICNAME

static final java.lang.String BUNDLE_SYMBOLICNAME

Manifest header 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

See Also:

Constant Field Values

SINGLETON_DIRECTIVE

static final java.lang.String SINGLETON_DIRECTIVE

Manifest header directive 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
 

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

Since:

1.3

See Also:

BUNDLE_SYMBOLICNAME, Constant Field Values

FRAGMENT_ATTACHMENT_DIRECTIVE

static final java.lang.String FRAGMENT_ATTACHMENT_DIRECTIVE

Manifest header directive 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"
 

Since:

1.3

See Also:

BUNDLE_SYMBOLICNAME, FRAGMENT_ATTACHMENT_ALWAYS, FRAGMENT_ATTACHMENT_RESOLVETIME, FRAGMENT_ATTACHMENT_NEVER, Constant Field Values

FRAGMENT_ATTACHMENT_ALWAYS

static final java.lang.String FRAGMENT_ATTACHMENT_ALWAYS

Manifest header directive value 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"
 

Since:

1.3

See Also:

FRAGMENT_ATTACHMENT_DIRECTIVE, Constant Field Values

FRAGMENT_ATTACHMENT_RESOLVETIME

static final java.lang.String FRAGMENT_ATTACHMENT_RESOLVETIME

Manifest header directive value 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"
 

Since:

1.3

See Also:

FRAGMENT_ATTACHMENT_DIRECTIVE, Constant Field Values

FRAGMENT_ATTACHMENT_NEVER

static final java.lang.String FRAGMENT_ATTACHMENT_NEVER

Manifest header directive value 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"
 

Since:

1.3

See Also:

FRAGMENT_ATTACHMENT_DIRECTIVE, Constant Field Values

BUNDLE_LOCALIZATION

static final java.lang.String BUNDLE_LOCALIZATION

Manifest header 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.

Since:

1.3

See Also:

BUNDLE_LOCALIZATION_DEFAULT_BASENAME, Constant Field Values

BUNDLE_LOCALIZATION_DEFAULT_BASENAME

static final java.lang.String BUNDLE_LOCALIZATION_DEFAULT_BASENAME

Default value for the Bundle-Localization manifest header.

Since:

1.3

See Also:

BUNDLE_LOCALIZATION, Constant Field Values

REQUIRE_BUNDLE

static final java.lang.String REQUIRE_BUNDLE

Manifest header 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

See Also:

Constant Field Values

BUNDLE_VERSION_ATTRIBUTE

static final java.lang.String BUNDLE_VERSION_ATTRIBUTE

Manifest header attribute 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

See Also:

REQUIRE_BUNDLE, Constant Field Values

FRAGMENT_HOST

static final java.lang.String FRAGMENT_HOST

Manifest header 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

See Also:

Constant Field Values

SELECTION_FILTER_ATTRIBUTE

static final java.lang.String SELECTION_FILTER_ATTRIBUTE

Manifest header attribute 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

See Also:

BUNDLE_NATIVECODE, Constant Field Values

BUNDLE_MANIFESTVERSION

static final java.lang.String BUNDLE_MANIFESTVERSION

Manifest header 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 Release 4, or later, syntax must specify a bundle manifest version.

The bundle manifest version defined by OSGi Release 4 or, more specifically, by version 1.3 of the OSGi Core Specification is "2".

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

Since:

1.3

See Also:

Constant Field Values

VERSION_ATTRIBUTE

static final java.lang.String VERSION_ATTRIBUTE

Manifest header attribute 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

See Also:

EXPORT_PACKAGE, IMPORT_PACKAGE, Constant Field Values

BUNDLE_SYMBOLICNAME_ATTRIBUTE

static final java.lang.String BUNDLE_SYMBOLICNAME_ATTRIBUTE

Manifest header attribute 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

See Also:

IMPORT_PACKAGE, Constant Field Values

RESOLUTION_DIRECTIVE

static final java.lang.String RESOLUTION_DIRECTIVE

Manifest header directive identifying the resolution type in the Import-Package or Require-Bundle manifest header. The default value is mandatory.

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"
 

Since:

1.3

See Also:

IMPORT_PACKAGE, REQUIRE_BUNDLE, RESOLUTION_MANDATORY, RESOLUTION_OPTIONAL, Constant Field Values

RESOLUTION_MANDATORY

static final java.lang.String RESOLUTION_MANDATORY

Manifest header directive value 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"
 

Since:

1.3

See Also:

RESOLUTION_DIRECTIVE, Constant Field Values

RESOLUTION_OPTIONAL

static final java.lang.String RESOLUTION_OPTIONAL

Manifest header directive value 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"
 

Since:

1.3

See Also:

RESOLUTION_DIRECTIVE, Constant Field Values

USES_DIRECTIVE

static final java.lang.String USES_DIRECTIVE

Manifest header directive 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

See Also:

EXPORT_PACKAGE, Constant Field Values

INCLUDE_DIRECTIVE

static final java.lang.String INCLUDE_DIRECTIVE

Manifest header directive identifying a list of classes to include in the exported package.

This directive is used by the Export-Package manifest header to identify a list of classes of the specified package which must be allowed to be exported. The directive value is encoded in the Export-Package manifest header like:

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

This directive is also used by the Bundle-ActivationPolicy manifest header to identify the packages from which class loads will trigger lazy activation. The directive value is encoded in the Bundle-ActivationPolicy manifest header like:

     Bundle-ActivationPolicy: lazy; include:="org.osgi.framework"
 

Since:

1.3

See Also:

EXPORT_PACKAGE, BUNDLE_ACTIVATIONPOLICY, Constant Field Values

EXCLUDE_DIRECTIVE

static final java.lang.String EXCLUDE_DIRECTIVE

Manifest header directive identifying a list of classes to exclude in the exported package..

This directive is used by the Export-Package manifest header to identify a list of classes of the specified package which must not be allowed to be exported. The directive value is encoded in the Export-Package manifest header like:

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

This directive is also used by the Bundle-ActivationPolicy manifest header to identify the packages from which class loads will not trigger lazy activation. The directive value is encoded in the Bundle-ActivationPolicy manifest header like:

     Bundle-ActivationPolicy: lazy; exclude:="org.osgi.framework"
 

Since:

1.3

See Also:

EXPORT_PACKAGE, BUNDLE_ACTIVATIONPOLICY, Constant Field Values

MANDATORY_DIRECTIVE

static final java.lang.String MANDATORY_DIRECTIVE

Manifest header directive 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

See Also:

EXPORT_PACKAGE, Constant Field Values

VISIBILITY_DIRECTIVE

static final java.lang.String VISIBILITY_DIRECTIVE

Manifest header directive identifying the visibility of a required bundle in the Require-Bundle manifest header. The default value is private.

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

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

Since:

1.3

See Also:

REQUIRE_BUNDLE, VISIBILITY_PRIVATE, VISIBILITY_REEXPORT, Constant Field Values

VISIBILITY_PRIVATE

static final java.lang.String VISIBILITY_PRIVATE

Manifest header 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.

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

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

Since:

1.3

See Also:

VISIBILITY_DIRECTIVE, Constant Field Values

VISIBILITY_REEXPORT

static final java.lang.String VISIBILITY_REEXPORT

Manifest header 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. 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"
 

Since:

1.3

See Also:

VISIBILITY_DIRECTIVE, Constant Field Values

EXTENSION_DIRECTIVE

static final java.lang.String EXTENSION_DIRECTIVE

Manifest header directive 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"
 

Since:

1.3

See Also:

FRAGMENT_HOST, EXTENSION_FRAMEWORK, EXTENSION_BOOTCLASSPATH, Constant Field Values

EXTENSION_FRAMEWORK

static final java.lang.String EXTENSION_FRAMEWORK

Manifest header directive value 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"
 

Since:

1.3

See Also:

EXTENSION_DIRECTIVE, Constant Field Values

EXTENSION_BOOTCLASSPATH

static final java.lang.String EXTENSION_BOOTCLASSPATH

Manifest header directive value 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"
 

Since:

1.3

See Also:

EXTENSION_DIRECTIVE, Constant Field Values

BUNDLE_ACTIVATIONPOLICY

static final java.lang.String BUNDLE_ACTIVATIONPOLICY

Manifest header identifying the bundle's activation policy.

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

Since:

1.4

See Also:

ACTIVATION_LAZY, INCLUDE_DIRECTIVE, EXCLUDE_DIRECTIVE, Constant Field Values

ACTIVATION_LAZY

static final java.lang.String ACTIVATION_LAZY

Bundle activation policy declaring the bundle must be activated when the first class load is made from the bundle.

A bundle with the lazy activation policy that is started with the START_ACTIVATION_POLICY option will wait in the STARTING state until the first class load from the bundle occurs. The bundle will then be activated before the class is returned to the requester.

The activation policy value is specified as in the Bundle-ActivationPolicy manifest header like:

       Bundle-ActivationPolicy: lazy
 

Since:

1.4

See Also:

BUNDLE_ACTIVATIONPOLICY, Bundle.start(int), Bundle.START_ACTIVATION_POLICY, Constant Field Values

FRAMEWORK_VERSION

static final java.lang.String FRAMEWORK_VERSION

Framework environment property identifying the Framework version.

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

See Also:

Constant Field Values

FRAMEWORK_VENDOR

static final java.lang.String FRAMEWORK_VENDOR

Framework environment property identifying the Framework implementation vendor.

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

See Also:

Constant Field Values

FRAMEWORK_LANGUAGE

static final java.lang.String FRAMEWORK_LANGUAGE

Framework environment property 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.

See Also:

Constant Field Values

FRAMEWORK_OS_NAME

static final java.lang.String FRAMEWORK_OS_NAME

Framework environment property identifying the Framework host-computer's operating system.

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

See Also:

Constant Field Values

FRAMEWORK_OS_VERSION

static final java.lang.String FRAMEWORK_OS_VERSION

Framework environment property identifying the Framework host-computer's operating system version number.

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

See Also:

Constant Field Values

FRAMEWORK_PROCESSOR

static final java.lang.String FRAMEWORK_PROCESSOR

Framework environment property identifying the Framework host-computer's processor name.

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

See Also:

Constant Field Values

FRAMEWORK_EXECUTIONENVIRONMENT

static final java.lang.String FRAMEWORK_EXECUTIONENVIRONMENT

Framework environment property identifying execution environments provided by the Framework.

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

Since:

1.2

See Also:

Constant Field Values

FRAMEWORK_BOOTDELEGATION

static final java.lang.String FRAMEWORK_BOOTDELEGATION

Framework environment property identifying packages for which the Framework must delegate class loading to the parent class loader of the bundle.

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

Since:

1.3

See Also:

FRAMEWORK_BUNDLE_PARENT, Constant Field Values

FRAMEWORK_SYSTEMPACKAGES

static final java.lang.String FRAMEWORK_SYSTEMPACKAGES

Framework environment property identifying packages which the system bundle must export.

If this property is not specified then the framework must calculate a reasonable default value for the current execution environment.

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

Since:

1.3

See Also:

Constant Field Values

FRAMEWORK_SYSTEMPACKAGES_EXTRA

static final java.lang.String FRAMEWORK_SYSTEMPACKAGES_EXTRA

Framework environment property identifying extra packages which the system bundle must export from the current execution environment.

This property is useful for configuring extra system packages in addition to the system packages calculated by the framework.

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

Since:

1.5

See Also:

FRAMEWORK_SYSTEMPACKAGES, Constant Field Values

SUPPORTS_FRAMEWORK_EXTENSION

static final java.lang.String SUPPORTS_FRAMEWORK_EXTENSION

Framework environment property identifying whether the Framework supports framework extension bundles.

As of version 1.4, the value of this property must be true. The Framework must support framework extension bundles.

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

Since:

1.3

See Also:

Constant Field Values

SUPPORTS_BOOTCLASSPATH_EXTENSION

static final java.lang.String SUPPORTS_BOOTCLASSPATH_EXTENSION

Framework environment property 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

See Also:

Constant Field Values

SUPPORTS_FRAMEWORK_FRAGMENT

static final java.lang.String SUPPORTS_FRAMEWORK_FRAGMENT

Framework environment property identifying whether the Framework supports fragment bundles.

As of version 1.4, the value of this property must be true. The Framework must support fragment bundles.

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

Since:

1.3

See Also:

Constant Field Values

SUPPORTS_FRAMEWORK_REQUIREBUNDLE

static final java.lang.String SUPPORTS_FRAMEWORK_REQUIREBUNDLE

Framework environment property identifying whether the Framework supports the Require-Bundle manifest header.

As of version 1.4, the value of this property must be true. The Framework must support the Require-Bundle manifest header.

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

Since:

1.3

See Also:

Constant Field Values

FRAMEWORK_SECURITY

static final java.lang.String FRAMEWORK_SECURITY

Specifies the type of security manager the framework must use. If not specified then the framework will not set the VM security manager.

Since:

1.5

See Also:

FRAMEWORK_SECURITY_OSGI, Constant Field Values

FRAMEWORK_SECURITY_OSGI

static final java.lang.String FRAMEWORK_SECURITY_OSGI

Specifies that a security manager that supports all security aspects of the OSGi core specification including postponed conditions must be installed.

If this value is specified and there is a security manager already installed, then a SecurityException must be thrown when the Framework is initialized.

Since:

1.5

See Also:

FRAMEWORK_SECURITY, Constant Field Values

FRAMEWORK_STORAGE

static final java.lang.String FRAMEWORK_STORAGE

Specified the persistent storage area used by the framework. The value of this property must be a valid file path in the file system to a directory. If the specified directory does not exist then the framework will create the directory. If the specified path exists but is not a directory or if the framework fails to create the storage directory, then framework initialization must fail. The framework is free to use this directory as it sees fit. This area can not be shared with anything else.

If this property is not set, the framework should use a reasonable platform default for the persistent storage area.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_STORAGE_CLEAN

static final java.lang.String FRAMEWORK_STORAGE_CLEAN

Specifies if and when the persistent storage area for the framework should be cleaned. If this property is not set, then the framework storage area must not be cleaned.

Since:

1.5

See Also:

FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT, Constant Field Values

FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT

static final java.lang.String FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT

Specifies that the framework storage area must be cleaned before the framework is initialized for the first time. Subsequent inits, starts or updates of the framework will not result in cleaning the framework storage area.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_LIBRARY_EXTENSIONS

static final java.lang.String FRAMEWORK_LIBRARY_EXTENSIONS

Specifies a comma separated list of additional library file extensions that must be used when a bundle's class loader is searching for native libraries. If this property is not set, then only the library name returned by System.mapLibraryName(String) will be used to search. This is needed for certain operating systems which allow more than one extension for a library. For example, AIX allows library extensions of .a and .so, but System.mapLibraryName(String) will only return names with the .a extension.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_EXECPERMISSION

static final java.lang.String FRAMEWORK_EXECPERMISSION

Specifies an optional OS specific command to set file permissions on extracted native code. On some operating systems, it is required that native libraries be set to executable. This optional property allows you to specify the command. For example, on a UNIX style OS, this property could have the following value.

 chmod +rx ${abspath}
 

The ${abspath} is used by the framework to substitute the actual absolute file path.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_TRUST_REPOSITORIES

static final java.lang.String FRAMEWORK_TRUST_REPOSITORIES

Specifies the trust repositories used by the framework. The value is a java.io.File.pathSeparator separated list of valid file paths to files that contain key stores of type JKS. The framework will use the key stores as trust repositories to authenticate certificates of trusted signers. The key stores are only used as read-only trust repositories to access public keys. No passwords are required to access the key stores' public keys.

Note that framework implementations are allowed to use other trust repositories in addition to the trust repositories specified by this property. How these other trust repositories are configured and populated is implementation specific.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_WINDOWSYSTEM

static final java.lang.String FRAMEWORK_WINDOWSYSTEM

Specifies the current windowing system. The framework should provide a reasonable default if this is not set.

Since:

1.5

See Also:

Constant Field Values

FRAMEWORK_BEGINNING_STARTLEVEL

static final java.lang.String FRAMEWORK_BEGINNING_STARTLEVEL

Specifies the beginning start level of the framework.

Since:

1.5

See Also:

"Core Specification, section 8.2.3.", Constant Field Values

FRAMEWORK_BUNDLE_PARENT

static final java.lang.String FRAMEWORK_BUNDLE_PARENT

Specifies the parent class loader type for all bundle class loaders. Default value is boot.

Since:

1.5

See Also:

FRAMEWORK_BUNDLE_PARENT_BOOT, FRAMEWORK_BUNDLE_PARENT_EXT, FRAMEWORK_BUNDLE_PARENT_APP, FRAMEWORK_BUNDLE_PARENT_FRAMEWORK, Constant Field Values

FRAMEWORK_BUNDLE_PARENT_BOOT

static final java.lang.String FRAMEWORK_BUNDLE_PARENT_BOOT

Specifies to use of the boot class loader as the parent class loader for all bundle class loaders.

Since:

1.5

See Also:

FRAMEWORK_BUNDLE_PARENT, Constant Field Values

FRAMEWORK_BUNDLE_PARENT_EXT

static final java.lang.String FRAMEWORK_BUNDLE_PARENT_EXT

Specifies to use the extension class loader as the parent class loader for all bundle class loaders.

Since:

1.5

See Also:

FRAMEWORK_BUNDLE_PARENT, Constant Field Values

FRAMEWORK_BUNDLE_PARENT_APP

static final java.lang.String FRAMEWORK_BUNDLE_PARENT_APP

Specifies to use the application class loader as the parent class loader for all bundle class loaders. Depending on how the framework is launched, this may refer to the same class loader as FRAMEWORK_BUNDLE_PARENT_FRAMEWORK.

Since:

1.5

See Also:

FRAMEWORK_BUNDLE_PARENT, Constant Field Values

FRAMEWORK_BUNDLE_PARENT_FRAMEWORK

static final java.lang.String FRAMEWORK_BUNDLE_PARENT_FRAMEWORK

Specifies to use the framework class loader as the parent class loader for all bundle class loaders. The framework class loader is the class loader used to load the framework implementation. Depending on how the framework is launched, this may refer to the same class loader as FRAMEWORK_BUNDLE_PARENT_APP.

Since:

1.5

See Also:

FRAMEWORK_BUNDLE_PARENT, Constant Field Values

OBJECTCLASS

static final java.lang.String OBJECTCLASS

Service property identifying all of the class names under which a service was registered in the Framework. The value of this property must be of type String[].

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

See Also:

Constant Field Values

SERVICE_ID

static final java.lang.String SERVICE_ID

Service property identifying a service's registration number. The value of this property must be of type 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.

See Also:

Constant Field Values

SERVICE_PID

static final java.lang.String SERVICE_PID

Service property identifying a service's persistent identifier.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method. The value of this property must be of type String, String[], or Collection of String.

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.

See Also:

Constant Field Values

SERVICE_RANKING

static final java.lang.String SERVICE_RANKING

Service property identifying a service's ranking number.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method. The value of this property must be of type Integer.

The service ranking is used by the Framework to determine the natural order of services, see ServiceReference.compareTo(Object), and the default service to be returned from a call to the BundleContext.getServiceReference(java.lang.String) method.

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 Integer, it is deemed to have a ranking value of zero.

See Also:

Constant Field Values

SERVICE_VENDOR

static final java.lang.String SERVICE_VENDOR

Service property identifying a service's vendor.

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

See Also:

Constant Field Values

SERVICE_DESCRIPTION

static final java.lang.String SERVICE_DESCRIPTION

Service property identifying a service's description.

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

See Also:

Constant Field Values