org.osgi.framework
public interface Constants
The values associated with these keys are of type
java.lang.String
, unless otherwise indicated.
Since: 1.1
Version: $Revision: 1.32 $
Field Summary | |
---|---|
static String | ACTIVATION_LAZY
Bundle activation policy (named "lazy") declaring the bundle
must be activated when the first class load is made from the bundle.
|
static String | BUNDLE_ACTIVATIONPOLICY
Manifest header (named "Bundle-ActivationPolicy") identifying
the bundle's activation policy.
|
static String | BUNDLE_ACTIVATOR
Manifest header attribute (named "Bundle-Activator")
identifying the bundle's activator class.
|
static String | BUNDLE_CATEGORY
Manifest header (named "Bundle-Category") identifying the
bundle's category.
|
static String | 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 String | 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 String | BUNDLE_COPYRIGHT
Manifest header (named "Bundle-Copyright") identifying the
bundle's copyright information.
|
static String | BUNDLE_DESCRIPTION
Manifest header (named "Bundle-Description") containing a brief
description of the bundle's functionality.
|
static String | BUNDLE_DOCURL
Manifest header (named "Bundle-DocURL") identifying the
bundle's documentation URL, from which further information about the
bundle may be obtained.
|
static String | BUNDLE_LOCALIZATION
Manifest header (named "Bundle-Localization") identifying the
base name of the bundle's localization entries.
|
static String | BUNDLE_LOCALIZATION_DEFAULT_BASENAME
Default value for the Bundle-Localization manifest header.
|
static String | BUNDLE_MANIFESTVERSION
Manifest header (named "Bundle-ManifestVersion") identifying
the bundle manifest version. |
static String | BUNDLE_NAME
Manifest header (named "Bundle-Name") identifying the bundle's
name.
|
static String | 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 String | BUNDLE_NATIVECODE_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 String | BUNDLE_NATIVECODE_OSNAME
Manifest header attribute (named "osname") identifying the
operating system required to run native bundle code specified in the
Bundle-NativeCode manifest header).
|
static String | BUNDLE_NATIVECODE_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 String | BUNDLE_NATIVECODE_PROCESSOR
Manifest header attribute (named "processor") identifying the
processor required to run native bundle code specified in the
Bundle-NativeCode manifest header).
|
static String | BUNDLE_REQUIREDEXECUTIONENVIRONMENT
Manifest header (named "Bundle-RequiredExecutionEnvironment")
identifying the required execution environment for the bundle. |
static String | BUNDLE_SYMBOLICNAME
Manifest header (named "Bundle-SymbolicName") identifying the
bundle's symbolic name.
|
static String | BUNDLE_SYMBOLICNAME_ATTRIBUTE
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 String | BUNDLE_UPDATELOCATION
Manifest header (named "Bundle-UpdateLocation") identifying the
location from which a new bundle version is obtained during a bundle
update operation.
|
static String | BUNDLE_VENDOR
Manifest header (named "Bundle-Vendor") identifying the
bundle's vendor.
|
static String | BUNDLE_VERSION
Manifest header (named "Bundle-Version") identifying the
bundle's version.
|
static String | BUNDLE_VERSION_ATTRIBUTE
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 String | DYNAMICIMPORT_PACKAGE
Manifest header (named "DynamicImport-Package") identifying the
packages that the bundle may dynamically import during execution.
|
static String | EXCLUDE_DIRECTIVE
Manifest header directive (named "exclude").
|
static String | EXPORT_PACKAGE
Manifest header (named "Export-Package") identifying the
packages that the bundle offers to the Framework for export.
|
static String | 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 String | EXTENSION_BOOTCLASSPATH
Manifest header directive value (named "bootclasspath")
identifying the type of extension fragment. |
static String | EXTENSION_DIRECTIVE
Manifest header directive (named "extension") identifying the
type of the extension fragment.
|
static String | EXTENSION_FRAMEWORK
Manifest header directive value (named "framework") identifying
the type of extension fragment. |
static String | FRAGMENT_ATTACHMENT_ALWAYS
Manifest header directive value (named "always") identifying a
fragment attachment type of always. |
static String | FRAGMENT_ATTACHMENT_DIRECTIVE
Manifest header directive (named "fragment-attachment")
identifying if and when a fragment may attach to a host bundle. |
static String | FRAGMENT_ATTACHMENT_NEVER
Manifest header directive value (named "never") identifying a
fragment attachment type of never. |
static String | FRAGMENT_ATTACHMENT_RESOLVETIME
Manifest header directive value (named "resolve-time")
identifying a fragment attachment type of resolve-time. |
static String | FRAGMENT_HOST
Manifest header (named "Fragment-Host") identifying the
symbolic name of another bundle for which that the bundle is a fragment.
|
static String | 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 String | FRAMEWORK_EXECUTIONENVIRONMENT
Framework environment property (named
"org.osgi.framework.executionenvironment") identifying
execution environments provided by the Framework.
|
static String | FRAMEWORK_LANGUAGE
Framework environment property (named
"org.osgi.framework.language") identifying the Framework
implementation language (see ISO 639 for possible values).
|
static String | FRAMEWORK_OS_NAME
Framework environment property (named
"org.osgi.framework.os.name") identifying the Framework
host-computer's operating system.
|
static String | FRAMEWORK_OS_VERSION
Framework environment property (named
"org.osgi.framework.os.version") identifying the Framework
host-computer's operating system version number.
|
static String | FRAMEWORK_PROCESSOR
Framework environment property (named
"org.osgi.framework.processor") identifying the Framework
host-computer's processor name.
|
static String | FRAMEWORK_SYSTEMPACKAGES
Framework environment property (named
"org.osgi.framework.system.packages") identifying package which
the system bundle must export.
|
static String | FRAMEWORK_VENDOR
Framework environment property (named
"org.osgi.framework.vendor") identifying the Framework
implementation vendor.
|
static String | FRAMEWORK_VERSION
Framework environment property (named
"org.osgi.framework.version") identifying the Framework
version.
|
static String | IMPORT_PACKAGE
Manifest header (named "Import-Package") identifying the
packages on which the bundle depends.
|
static String | 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 String | INCLUDE_DIRECTIVE
Manifest header directive (named "include").
|
static String | MANDATORY_DIRECTIVE
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 String | 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 String | PACKAGE_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 String | REQUIRE_BUNDLE
Manifest header (named "Require-Bundle") identifying the
symbolic names of other bundles required by the bundle.
|
static String | RESOLUTION_DIRECTIVE
Manifest header directive (named "resolution") identifying the
resolution type in the Import-Package or Require-Bundle manifest header.
|
static String | RESOLUTION_MANDATORY
Manifest header directive value (named "mandatory") identifying
a mandatory resolution type. |
static String | RESOLUTION_OPTIONAL
Manifest header directive value (named "optional") identifying
an optional resolution type. |
static String | SELECTION_FILTER_ATTRIBUTE
Manifest header attribute (named "selection-filter") is used
for selection by filtering based upon system properties.
|
static String | SERVICE_DESCRIPTION
Service property (named "service.description") identifying a
service's description.
|
static String | SERVICE_ID
Service property (named "service.id") identifying a service's
registration number (of type java.lang.Long ).
|
static String | SERVICE_PID
Service property (named "service.pid") identifying a service's
persistent identifier.
|
static String | SERVICE_RANKING
Service property (named "service.ranking") identifying a
service's ranking number (of type java.lang.Integer ).
|
static String | SERVICE_VENDOR
Service property (named "service.vendor") identifying a
service's vendor.
|
static String | SINGLETON_DIRECTIVE
Manifest header directive (named "singleton") identifying
whether a bundle is a singleton. |
static String | SUPPORTS_BOOTCLASSPATH_EXTENSION
Framework environment property (named
"org.osgi.supports.bootclasspath.extension") identifying
whether the Framework supports bootclasspath extension bundles. |
static String | SUPPORTS_FRAMEWORK_EXTENSION
Framework environment property (named
"org.osgi.supports.framework.extension") identifying whether
the Framework supports framework extension bundles. |
static String | SUPPORTS_FRAMEWORK_FRAGMENT
Framework environment property (named
"org.osgi.supports.framework.fragment") identifying whether the
Framework supports fragment bundles. |
static String | SUPPORTS_FRAMEWORK_REQUIREBUNDLE
Framework environment property (named
"org.osgi.supports.framework.requirebundle") identifying
whether the Framework supports the Require-Bundle manifest
header. |
static String | SYSTEM_BUNDLE_LOCATION
Location identifier of the OSGi system bundle , which is defined
to be "System Bundle". |
static String | SYSTEM_BUNDLE_SYMBOLICNAME
Alias for the symbolic name of the OSGi system bundle . |
static String | USES_DIRECTIVE
Manifest header directive (named "uses") identifying a list of
packages that an exported package uses.
|
static String | VERSION_ATTRIBUTE
Manifest header attribute (named "version") identifying the
version of a package specified in the Export-Package or Import-Package
manifest header.
|
static String | VISIBILITY_DIRECTIVE
Manifest header directive (named "visibility") identifying the
visibility of a reqiured bundle in the Require-Bundle manifest header.
|
static String | VISIBILITY_PRIVATE
Manifest header directive value (named "private") identifying a
private visibility type. |
static String | VISIBILITY_REEXPORT
Manifest header directive value (named "reexport") identifying
a reexport visibility type. |
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 requestor.
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_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
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.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
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
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
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value is encoded in the Bundle-NativeCode manifest header like:
Bundle-NativeCode: http.so ; language=nl_be ...
The attribute value is encoded in the Bundle-NativeCode manifest header like:
Bundle-NativeCode: http.so ; osname=Linux ...
The attribute value is encoded in the Bundle-NativeCode manifest header like:
Bundle-NativeCode: http.so ; osversion="2.34" ...
The attribute value is encoded in the Bundle-NativeCode manifest header like:
Bundle-NativeCode: http.so ; processor=x86 ...
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Since: 1.2
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Since: 1.3
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
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
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
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Since: 1.2
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
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Deprecated: As of 1.2.
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.
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
The directive value is encoded in the Fragment-Host manifest header like:
Fragment-Host: system.bundle; extension:="framework"
Since: 1.3
See Also: EXTENSION_FRAMEWORK EXTENSION_BOOTCLASSPATH
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
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
"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: FRAGMENT_ATTACHMENT_ALWAYS FRAGMENT_ATTACHMENT_RESOLVETIME FRAGMENT_ATTACHMENT_NEVER
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
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
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Since: 1.3
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
Since: 1.3
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
Since: 1.2
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
Since: 1.3
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
The attribute value may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Deprecated: As of 1.2.
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.
This directive is used by the Import-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 Import-Package manifest header like:
Import-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
The directive value is encoded in the Export-Package manifest header like:
Export-Package: org.osgi.framework; mandatory:="bundle-symbolic-name"
Since: 1.3
java.lang.String[]
).
This property is set by the Framework when a service is registered.
Deprecated: As of 1.3. This has been replaced by VERSION_ATTRIBUTE.
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 may be retrieved from the Dictionary
object returned by the Bundle.getHeaders
method.
Since: 1.3
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_MANDATORY RESOLUTION_OPTIONAL
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
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
The attribute value is encoded in manifest headers like:
Bundle-NativeCode: libgtk.so; selection-filter="(ws=gtk)"; ...
Since: 1.3
This property may be supplied in the properties Dictionary
object passed to the BundleContext.registerService
method.
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.
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) and followed by a dot (.). A bundle may use this as the prefix of the persistent identifiers for the services it registers.
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 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.
This property may be supplied in the properties Dictionary
object passed to the BundleContext.registerService
method.
false
.
The directive value is encoded in the Bundle-SymbolicName manifest header like:
Bundle-SymbolicName: com.acme.module.test; singleton:=true
Since: 1.3
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
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
true
. The Framework must support
fragment bundles.
The value of this property may be retrieved by calling the
BundleContext.getProperty
method.
Since: 1.3
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
Since: 1.3
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
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
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_PRIVATE VISIBILITY_REEXPORT
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
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