Top Description Fields
org.osgi.framework

public Interface Constants

Annotations
@ProviderType
Imports
org.osgi.annotation.versioning.ProviderType, org.osgi.framework.hooks.bundle.CollisionHook, org.osgi.framework.launch.Framework

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.

Author
$Id: 57af8721d5f7e08f9b8a1d9f109a5ebb94bf9646 $
Since
1.1

Field Summary

Modifier and TypeField and Description
public static final String
ACTIVATION_LAZY

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

public static final String
BUNDLE_ACTIVATIONPOLICY

Manifest header identifying the bundle's activation policy.

public static final String
BUNDLE_ACTIVATOR

Manifest header identifying the bundle's activator class.

public static final String
BUNDLE_CATEGORY

Manifest header identifying the bundle's category.

public static final 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.

public static final String
BUNDLE_CONTACTADDRESS

Manifest header identifying the contact address where problems with the bundle may be reported; for example, an email address.

public static final String
BUNDLE_COPYRIGHT

Manifest header identifying the bundle's copyright information.

public static final String
BUNDLE_DESCRIPTION

Manifest header containing a brief description of the bundle's functionality.

public static final String
BUNDLE_DEVELOPERS

Manifest header identifying the bundle's developers.

public static final String
BUNDLE_DOCURL

Manifest header identifying the bundle's documentation URL, from which further information about the bundle may be obtained.

public static final String
BUNDLE_ICON

Manifest header identifying the bundle's icon URLs.

public static final String
BUNDLE_LICENSE

Manifest header identifying the bundle's license information.

public static final String
BUNDLE_LOCALIZATION

Manifest header identifying the base name of the bundle's localization entries.

public static final String
BUNDLE_LOCALIZATION_DEFAULT_BASENAME

Default value for the Bundle-Localization manifest header.

public static final String
BUNDLE_MANIFESTVERSION

Manifest header identifying the bundle manifest version.

public static final String
BUNDLE_NAME

Manifest header identifying the bundle's name.

public static final 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.

public static final 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.

public static final String
BUNDLE_NATIVECODE_OSNAME

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

public static final 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).

public static final String
BUNDLE_NATIVECODE_PROCESSOR

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

public static final String
BUNDLE_REQUIREDEXECUTIONENVIRONMENT

Deprecated As of 1.6. Replaced by the osgi.ee capability.
Manifest header identifying the required execution environment for the bundle.
public static final String
BUNDLE_SCM

Manifest header identifying the bundle's software configuration management system.

public static final String
BUNDLE_SYMBOLICNAME

Manifest header identifying the bundle's symbolic name.

public static final 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.

public static final String
BUNDLE_UPDATELOCATION

Manifest header identifying the location from which a new bundle version is obtained during a bundle update operation.

public static final String
BUNDLE_VENDOR

Manifest header identifying the bundle's vendor.

public static final String
BUNDLE_VERSION

Manifest header identifying the bundle's version.

public static final 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.

public static final String
DYNAMICIMPORT_PACKAGE

Manifest header identifying the packages that the bundle may dynamically import during execution.

public static final String
EFFECTIVE_ACTIVE

Manifest header directive value identifying a capability that is effective at active time.

public static final String
EFFECTIVE_DIRECTIVE

Manifest header directive identifying the effective time of the provided capability.

public static final String
EFFECTIVE_RESOLVE

Manifest header directive value identifying a capability that is effective at resolve time.

public static final String
EXCLUDE_DIRECTIVE

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

public static final String
EXPORT_PACKAGE

Manifest header identifying the packages that the bundle offers to the Framework for export.

public static final 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).
public static final String
EXTENSION_BOOTCLASSPATH

Deprecated As of 1.9.
Manifest header directive value identifying the type of extension fragment.
public static final String
EXTENSION_BUNDLE_ACTIVATOR

Manifest header identifying the extension bundle's activator class.

public static final String
EXTENSION_DIRECTIVE

Manifest header directive identifying the type of the extension fragment.

public static final String
EXTENSION_FRAMEWORK

Manifest header directive value identifying the type of extension fragment.

public static final String
FILTER_DIRECTIVE

Manifest header directive identifying the capability filter specified in the Require-Capability manifest header.

public static final String
FRAGMENT_ATTACHMENT_ALWAYS

Manifest header directive value identifying a fragment attachment type of always.

public static final String
FRAGMENT_ATTACHMENT_DIRECTIVE

Manifest header directive identifying if and when a fragment may attach to a host bundle.

public static final String
FRAGMENT_ATTACHMENT_NEVER

Manifest header directive value identifying a fragment attachment type of never.

public static final String
FRAGMENT_ATTACHMENT_RESOLVETIME

Manifest header directive value identifying a fragment attachment type of resolve-time.

public static final String
FRAGMENT_HOST

Manifest header identifying the symbolic name of another bundle for which that the bundle is a fragment.

public static final String
FRAMEWORK_BEGINNING_STARTLEVEL

Framework launching property specifying the beginning start level of the framework.

public static final String
FRAMEWORK_BOOTDELEGATION

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

public static final String
FRAMEWORK_BSNVERSION

Framework launching property specifying whether multiple bundles having the same symbolic name and version may be installed.

public static final String
FRAMEWORK_BSNVERSION_MANAGED

Specifies the framework must consult the bundle collision hook services to determine if it will be an error to install a bundle or update a bundle to have the same symbolic name and version as another installed bundle.

public static final String
FRAMEWORK_BSNVERSION_MULTIPLE

Specifies the framework will allow multiple bundles to be installed having the same symbolic name and version.

public static final String
FRAMEWORK_BSNVERSION_SINGLE

Specifies the framework will only allow a single bundle to be installed for a given symbolic name and version.

public static final String
FRAMEWORK_BUNDLE_PARENT

Framework launching property specifying the parent class loader type for all bundle class loaders.

public static final String
FRAMEWORK_BUNDLE_PARENT_APP

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

public static final String
FRAMEWORK_BUNDLE_PARENT_BOOT

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

public static final String
FRAMEWORK_BUNDLE_PARENT_EXT

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

public static final String
FRAMEWORK_BUNDLE_PARENT_FRAMEWORK

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

public static final String
FRAMEWORK_COMMAND_ABSPATH

Specified the substitution string for the absolute path of a file.

public static final String
FRAMEWORK_EXECPERMISSION

Framework launching property specifying an optional OS specific command to set file permissions on extracted native code.

public static final String
FRAMEWORK_EXECUTIONENVIRONMENT

Deprecated As of 1.6. Replaced by the osgi.ee capability.
Framework launching property identifying execution environments provided by the Framework.
public static final String
FRAMEWORK_LANGUAGE

Framework launching property identifying the Framework implementation language (see ISO 639 for possible values).

public static final String
FRAMEWORK_LIBRARY_EXTENSIONS

Framework launching property specifying a comma separated list of additional library file extensions that must be used when a bundle's class loader is searching for native libraries.

public static final String
FRAMEWORK_OS_NAME

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

public static final String
FRAMEWORK_OS_VERSION

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

public static final String
FRAMEWORK_PROCESSOR

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

public static final String
FRAMEWORK_SECURITY

Framework launching property specifying the type of security manager the framework must use.

public static final 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.

public static final String
FRAMEWORK_STORAGE

Framework launching property specifying the persistent storage area used by the framework.

public static final String
FRAMEWORK_STORAGE_CLEAN

Framework launching property specifying if and when the persistent storage area for the framework should be cleaned.

public static final String
FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT

Specifies that the framework storage area must be cleaned before the framework is initialized for the first time.

public static final String
FRAMEWORK_SYSTEMCAPABILITIES

Framework launching property identifying capabilities which the system bundle must provide.

public static final String
FRAMEWORK_SYSTEMCAPABILITIES_EXTRA

Framework launching property identifying extra capabilities which the system bundle must additionally provide.

public static final String
FRAMEWORK_SYSTEMPACKAGES

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

public static final String
FRAMEWORK_SYSTEMPACKAGES_EXTRA

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

public static final String
FRAMEWORK_TRUST_REPOSITORIES

Framework launching property specifying the trust repositories used by the framework.

public static final String
FRAMEWORK_UUID

Framework environment property identifying the Framework's universally unique identifier (UUID).

public static final String
FRAMEWORK_VENDOR

Framework environment property identifying the Framework implementation vendor.

public static final String
FRAMEWORK_VERSION

Framework environment property identifying the Framework version.

public static final String
FRAMEWORK_WINDOWSYSTEM

Framework launching property specifying the current windowing system.

public static final String
IMPORT_PACKAGE

Manifest header identifying the packages on which the bundle depends.

public static final 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).
public static final String
INCLUDE_DIRECTIVE

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

public static final String
INTENT_ASYNC

Intent supported by Remote Service implementations that support Asynchronous Remote Services as defined for the osgi.async intent.

public static final String
INTENT_BASIC

Intent supported by Remote Services implementations that support Basic Remote Services as defined for the osgi.basic intent.

public static final String
INTENT_CONFIDENTIAL

Intent supported by Remote Service implementation that provide confidential communications as defined for the osgi.confidential intent.

public static final String
INTENT_PRIVATE

Intent supported by Remote Service implementations that provide private communications as defined for the osgi.private intent.

public static final 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.

public static final String
OBJECTCLASS

Service property identifying all of the class names under which a service was registered in the Framework.

public static final 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.
public static final String
PROVIDE_CAPABILITY

Manifest header identifying the capabilities that the bundle offers to provide to other bundles.

public static final String
REMOTE_CONFIGS_SUPPORTED

Service property identifying the configuration types supported by a distribution provider.

public static final String
REMOTE_INTENTS_SUPPORTED

Service property identifying the intents supported by a distribution provider.

public static final String
REQUIRE_BUNDLE

Manifest header identifying the symbolic names of other bundles required by the bundle.

public static final String
REQUIRE_CAPABILITY

Manifest header identifying the capabilities on which the bundle depends.

public static final String
RESOLUTION_DIRECTIVE

Manifest header directive identifying the resolution type in the Import-Package, Require-Bundle or Require-Capability manifest header.

public static final String
RESOLUTION_MANDATORY

Manifest header directive value identifying a mandatory resolution type.

public static final String
RESOLUTION_OPTIONAL

Manifest header directive value identifying an optional resolution type.

public static final String
SCOPE_BUNDLE

Service scope is bundle.

public static final String
SCOPE_PROTOTYPE

Service scope is prototype.

public static final String
SCOPE_SINGLETON

Service scope is singleton.

public static final String
SELECTION_FILTER_ATTRIBUTE

Manifest header attribute is used for selection by filtering based upon system properties.

public static final String
SERVICE_BUNDLEID

Service property identifying the bundle id of the bundle registering the service.

public static final String
SERVICE_CHANGECOUNT

Service property identifying the monotonically increasing change count of a service.

public static final String
SERVICE_DESCRIPTION

Service property identifying a service's description.

public static final String
SERVICE_EXPORTED_CONFIGS

Service property identifying the configuration types that should be used to export the service.

public static final String
SERVICE_EXPORTED_INTENTS

Service property identifying the intents that the distribution provider must implement to distribute the service.

public static final String
SERVICE_EXPORTED_INTENTS_EXTRA

Service property identifying the extra intents that the distribution provider must implement to distribute the service.

public static final String
SERVICE_EXPORTED_INTERFACES

Service property marking the service for export.

public static final String
SERVICE_ID

Service property identifying a service's registration number.

public static final String
SERVICE_IMPORTED

Service property identifying the service as imported.

public static final String
SERVICE_IMPORTED_CONFIGS

Service property identifying the configuration types used to import the service.

public static final String
SERVICE_INTENTS

Service property identifying the intents that this service implements.

public static final String
SERVICE_PID

Service property identifying a service's persistent identifier.

public static final String
SERVICE_RANKING

Service property identifying a service's ranking number.

public static final String
SERVICE_SCOPE

Service property identifying a service's scope.

public static final String
SERVICE_VENDOR

Service property identifying a service's vendor.

public static final String
SINGLETON_DIRECTIVE

Manifest header directive identifying whether a bundle is a singleton.

public static final String
SUPPORTS_BOOTCLASSPATH_EXTENSION

Deprecated As of 1.10.
Framework environment property identifying whether the Framework supports bootclasspath extension bundles.
public static final String
SUPPORTS_FRAMEWORK_EXTENSION

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

public static final String
SUPPORTS_FRAMEWORK_FRAGMENT

Framework environment property identifying whether the Framework supports fragment bundles.

public static final String
SUPPORTS_FRAMEWORK_REQUIREBUNDLE

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

public static final long
SYSTEM_BUNDLE_ID

Identifier of the OSGi system bundle , which is defined to be 0.

public static final String
SYSTEM_BUNDLE_LOCATION

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

public static final String
SYSTEM_BUNDLE_SYMBOLICNAME

Alias for the symbolic name of the OSGi system bundle .

public static final String
USES_DIRECTIVE

Manifest header directive identifying a list of packages that an exported package or provided capability uses.

public static final String
VERSION_ATTRIBUTE

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

public static final String
VISIBILITY_DIRECTIVE

Manifest header directive identifying the visibility of a required bundle in the Require-Bundle manifest header.

public static final String
VISIBILITY_PRIVATE

Manifest header directive value identifying a private visibility type.

public static final String
VISIBILITY_REEXPORT

Manifest header directive value identifying a reexport visibility type.