org.osgi.framework
Interface Constants

public interface Constants

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

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

Since:

1.1

Version:

$Revision: 1.1 $

Author:

Open Services Gateway Initiative

See Also:

Bundle.getHeaders(), BundleContext.getProperty(java.lang.String), BundleContext.registerService(java.lang.String[], java.lang.Object, java.util.Dictionary)

Field Summary

static java.lang.String	BUNDLE_ACTIVATOR Manifest header attribute (named "Bundle-Activator") identifying the bundle's activator class.
static java.lang.String	BUNDLE_CATEGORY Manifest header (named "Bundle-Category") identifying the bundle's category.
static java.lang.String	BUNDLE_CLASSPATH Manifest header (named "Bundle-ClassPath") identifying a list of nested JAR files, which are bundle resources used to extend the bundle's classpath.
static java.lang.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 java.lang.String	BUNDLE_COPYRIGHT Manifest header (named "Bundle-Copyright") identifying the bundle's copyright information, which may be retrieved from the Dictionary object returned by the Bundle.getHeaders method.
static java.lang.String	BUNDLE_DESCRIPTION Manifest header (named "Bundle-Description") containing a brief description of the bundle's functionality.
static java.lang.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 java.lang.String	BUNDLE_NAME Manifest header (named "Bundle-Name") identifying the bundle's name.
static java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String	BUNDLE_REQUIREDEXECUTIONENVIRONMENT Manifest header (named "Bundle-RequiredExecutionEnvironment") identifying the required execution environment for the bundle.
static java.lang.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 java.lang.String	BUNDLE_VENDOR Manifest header (named "Bundle-Vendor") identifying the bundle's vendor.
static java.lang.String	BUNDLE_VERSION Manifest header (named "Bundle-Version") identifying the bundle's version.
static java.lang.String	DYNAMICIMPORT_PACKAGE Manifest header (named "DynamicImport-Package") identifying the names of the packages that the bundle may dynamically import during execution.
static java.lang.String	EXPORT_PACKAGE Manifest header (named "Export-Package") identifying the names (and optionally version numbers) of the packages that the bundle offers to the Framework for export.
static java.lang.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 java.lang.String	FRAMEWORK_EXECUTIONENVIRONMENT Framework environment property (named "org.osgi.framework.executionenvironment") identifying execution environments provided by the Framework.
static java.lang.String	FRAMEWORK_LANGUAGE Framework environment property (named "org.osgi.framework.language") identifying the Framework implementation language (see ISO 639 for possible values).
static java.lang.String	FRAMEWORK_OS_NAME Framework environment property (named "org.osgi.framework.os.name") identifying the Framework host-computer's operating system.
static java.lang.String	FRAMEWORK_OS_VERSION Framework environment property (named "org.osgi.framework.os.version") identifying the Framework host-computer's operating system version number.
static java.lang.String	FRAMEWORK_PROCESSOR Framework environment property (named "org.osgi.framework.processor") identifying the Framework host-computer's processor name.
static java.lang.String	FRAMEWORK_VENDOR Framework environment property (named "org.osgi.framework.vendor") identifying the Framework implementation vendor.
static java.lang.String	FRAMEWORK_VERSION Framework environment property (named "org.osgi.framework.version") identifying the Framework version.
static java.lang.String	IMPORT_PACKAGE Manifest header (named "Import-Package") identifying the names (and optionally, version numbers) of the packages that the bundle is dependent on.
static java.lang.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 java.lang.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 java.lang.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 java.lang.String	SERVICE_DESCRIPTION Service property (named "service.description") identifying a service's description.
static java.lang.String	SERVICE_ID Service property (named "service.id") identifying a service's registration number (of type java.lang.Long).
static java.lang.String	SERVICE_PID Service property (named "service.pid") identifying a service's persistent identifier.
static java.lang.String	SERVICE_RANKING Service property (named "service.ranking") identifying a service's ranking number (of type java.lang.Integer).
static java.lang.String	SERVICE_VENDOR Service property (named "service.vendor") identifying a service's vendor.
static java.lang.String	SYSTEM_BUNDLE_LOCATION Location identifier of the OSGi system bundle, which is defined to be "System Bundle".

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

BUNDLE_CATEGORY

static final java.lang.String BUNDLE_CATEGORY

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

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

See Also:

Constant Field Values

BUNDLE_CLASSPATH

static final java.lang.String BUNDLE_CLASSPATH

Manifest header (named "Bundle-ClassPath") identifying a list of nested 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 (named "Bundle-Copyright") identifying the bundle's copyright information, which 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 (named "Bundle-Description") containing a brief description of the bundle's functionality.

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

See Also:

Constant Field Values

BUNDLE_NAME

static final java.lang.String BUNDLE_NAME

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE

static final java.lang.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.

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 (named "Export-Package") identifying the names (and optionally version numbers) of 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

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.

See Also:

Constant Field Values

IMPORT_PACKAGE

static final java.lang.String IMPORT_PACKAGE

Manifest header (named "Import-Package") identifying the names (and optionally, version numbers) of the packages that the bundle is dependent on.

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 (named "DynamicImport-Package") identifying the names of 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

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.

See Also:

Constant Field Values

BUNDLE_VENDOR

static final java.lang.String BUNDLE_VENDOR

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

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

See Also:

Constant Field Values

BUNDLE_VERSION

static final java.lang.String BUNDLE_VERSION

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

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

See Also:

Constant Field Values

BUNDLE_DOCURL

static final java.lang.String BUNDLE_DOCURL

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

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

See Also:

Constant Field Values

BUNDLE_CONTACTADDRESS

static final java.lang.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.

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 (named "Bundle-Activator") identifying the bundle's activator class.

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

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

See Also:

Constant Field Values

BUNDLE_UPDATELOCATION

static final java.lang.String BUNDLE_UPDATELOCATION

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

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

See Also:

Constant Field Values

PACKAGE_SPECIFICATION_VERSION

static final java.lang.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.

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE_PROCESSOR

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

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE_OSNAME

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

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE_OSVERSION

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

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

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

See Also:

Constant Field Values

BUNDLE_NATIVECODE_LANGUAGE

static final java.lang.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. 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:

Constant Field Values

BUNDLE_REQUIREDEXECUTIONENVIRONMENT

static final java.lang.String BUNDLE_REQUIREDEXECUTIONENVIRONMENT

Manifest header (named "Bundle-RequiredExecutionEnvironment") identifying the required execution environment for the bundle. The service platform may run this bundle if any of the execution environments named in this header matches one of the execution environments it implements.

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

Since:

1.2

See Also:

Constant Field Values

FRAMEWORK_VERSION

static final java.lang.String FRAMEWORK_VERSION

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

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

See Also:

Constant Field Values

FRAMEWORK_VENDOR

static final java.lang.String FRAMEWORK_VENDOR

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

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

See Also:

Constant Field Values

FRAMEWORK_LANGUAGE

static final java.lang.String FRAMEWORK_LANGUAGE

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

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

See Also:

Constant Field Values

FRAMEWORK_OS_NAME

static final java.lang.String FRAMEWORK_OS_NAME

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

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

See Also:

Constant Field Values

FRAMEWORK_OS_VERSION

static final java.lang.String FRAMEWORK_OS_VERSION

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

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

See Also:

Constant Field Values

FRAMEWORK_PROCESSOR

static final java.lang.String FRAMEWORK_PROCESSOR

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

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

See Also:

Constant Field Values

FRAMEWORK_EXECUTIONENVIRONMENT

static final java.lang.String FRAMEWORK_EXECUTIONENVIRONMENT

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

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

Since:

1.2

See Also:

Constant Field Values

OBJECTCLASS

static final java.lang.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[]).

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 (named "service.id") identifying a service's registration number (of type java.lang.Long).

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

See Also:

Constant Field Values

SERVICE_PID

static final java.lang.String SERVICE_PID

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

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

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

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

See Also:

Constant Field Values

SERVICE_RANKING

static final java.lang.String SERVICE_RANKING

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

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

The service ranking is used by the Framework to determine the default service to be returned from a call to the BundleContext.getServiceReference(java.lang.String)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.

See Also:

Constant Field Values

SERVICE_VENDOR

static final java.lang.String SERVICE_VENDOR

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

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

See Also:

Constant Field Values

SERVICE_DESCRIPTION

static final java.lang.String SERVICE_DESCRIPTION

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

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

See Also:

Constant Field Values