OSGi™ Enterprise
Release 5

org.osgi.jmx.framework
Interface PackageStateMBean


public interface PackageStateMBean

This MBean provides information about the package state of the framework.

ThreadSafe

Field Summary
static java.lang.String EXPORTING_BUNDLES
          The key EXPORTING_BUNDLE, used in EXPORTING_BUNDLES_ITEM.
static Item EXPORTING_BUNDLES_ITEM
          The item containing the bundle identifier in PACKAGE_TYPE.
static java.lang.String IMPORTING_BUNDLES
          The key IMPORTING_BUNDLES, used in IMPORTING_BUNDLES_ITEM.
static Item IMPORTING_BUNDLES_ITEM
          The item containing the bundle identifier in PACKAGE_TYPE.
static java.lang.String NAME
          The key NAME, used in NAME_ITEM.
static Item NAME_ITEM
          The item containing the name of the package in PACKAGE_TYPE.
static java.lang.String OBJECTNAME
          The fully qualified object name of this MBean.
static javax.management.openmbean.CompositeType PACKAGE_TYPE
          The Composite Type for a CompositeData representing a package.
static javax.management.openmbean.TabularType PACKAGES_TYPE
          The Tabular Type used in listPackages().
static java.lang.String REMOVAL_PENDING
          The name of the item containing the pending removal status of the package in the CompositeData.
static Item REMOVAL_PENDING_ITEM
          The item representing the removal pending status of a package.
static java.lang.String VERSION
          The name of the item containing the package version in the CompositeData.
static Item VERSION_ITEM
          The item containing the version of the package in PACKAGE_TYPE.
 
Method Summary
 long[] getExportingBundles(java.lang.String packageName, java.lang.String version)
          Answer the identifier of the bundle exporting the package
 long[] getImportingBundles(java.lang.String packageName, java.lang.String version, long exportingBundle)
          Answer the list of identifiers of the bundles importing the package
 boolean isRemovalPending(java.lang.String packageName, java.lang.String version, long exportingBundle)
          Answer if this package is exported by a bundle which has been updated or uninstalled
 javax.management.openmbean.TabularData listPackages()
          Answer the package state of the system in tabular form The Tabular Data is typed by PACKAGES_TYPE, which has PACKAGE_TYPE as its Composite Type.
 

Field Detail

OBJECTNAME

static final java.lang.String OBJECTNAME
The fully qualified object name of this MBean.

See Also:
Constant Field Values

EXPORTING_BUNDLES

static final java.lang.String EXPORTING_BUNDLES
The key EXPORTING_BUNDLE, used in EXPORTING_BUNDLES_ITEM.

See Also:
Constant Field Values

EXPORTING_BUNDLES_ITEM

static final Item EXPORTING_BUNDLES_ITEM
The item containing the bundle identifier in PACKAGE_TYPE. The key is EXPORTING_BUNDLES and the type is JmxConstants.LONG_ARRAY_TYPE.


IMPORTING_BUNDLES

static final java.lang.String IMPORTING_BUNDLES
The key IMPORTING_BUNDLES, used in IMPORTING_BUNDLES_ITEM.

See Also:
Constant Field Values

IMPORTING_BUNDLES_ITEM

static final Item IMPORTING_BUNDLES_ITEM
The item containing the bundle identifier in PACKAGE_TYPE. The key is IMPORTING_BUNDLES and the type is JmxConstants.LONG_ARRAY_TYPE.


NAME

static final java.lang.String NAME
The key NAME, used in NAME_ITEM.

See Also:
Constant Field Values

NAME_ITEM

static final Item NAME_ITEM
The item containing the name of the package in PACKAGE_TYPE. The key is NAME and the type is SimpleType.LONG.


REMOVAL_PENDING

static final java.lang.String REMOVAL_PENDING
The name of the item containing the pending removal status of the package in the CompositeData. Used

See Also:
Constant Field Values

REMOVAL_PENDING_ITEM

static final Item REMOVAL_PENDING_ITEM
The item representing the removal pending status of a package. The key is REMOVAL_PENDING and the type is SimpleType.BOOLEAN.


VERSION

static final java.lang.String VERSION
The name of the item containing the package version in the CompositeData. Used in VERSION_ITEM.

See Also:
Constant Field Values

VERSION_ITEM

static final Item VERSION_ITEM
The item containing the version of the package in PACKAGE_TYPE. The key is VERSION and the type is SimpleType.STRING.


PACKAGE_TYPE

static final javax.management.openmbean.CompositeType PACKAGE_TYPE
The Composite Type for a CompositeData representing a package. This type consists of: The key is defined as NAME and EXPORTING_BUNDLES


PACKAGES_TYPE

static final javax.management.openmbean.TabularType PACKAGES_TYPE
The Tabular Type used in listPackages(). They key is NAME, VERSION, and EXPORTING_BUNDLES.

Method Detail

getExportingBundles

long[] getExportingBundles(java.lang.String packageName,
                           java.lang.String version)
                           throws java.io.IOException
Answer the identifier of the bundle exporting the package

Parameters:
packageName - - the package name
version - - the version of the package
Returns:
the bundle identifiers exporting such a package
Throws:
java.io.IOException - if the operation fails
java.lang.IllegalArgumentException - if the package indicated does not exist

getImportingBundles

long[] getImportingBundles(java.lang.String packageName,
                           java.lang.String version,
                           long exportingBundle)
                           throws java.io.IOException
Answer the list of identifiers of the bundles importing the package

Parameters:
packageName - The package name
version - The version of the package
exportingBundle - The exporting bundle for the given package
Returns:
the list of bundle identifiers
Throws:
java.io.IOException - if the operation fails
java.lang.IllegalArgumentException - if the package indicated does not exist

listPackages

javax.management.openmbean.TabularData listPackages()
                                                    throws java.io.IOException
Answer the package state of the system in tabular form The Tabular Data is typed by PACKAGES_TYPE, which has PACKAGE_TYPE as its Composite Type.

Returns:
the tabular representation of the package state
Throws:
java.io.IOException - When fails

isRemovalPending

boolean isRemovalPending(java.lang.String packageName,
                         java.lang.String version,
                         long exportingBundle)
                         throws java.io.IOException
Answer if this package is exported by a bundle which has been updated or uninstalled

Parameters:
packageName - The package name
version - The version of the package
exportingBundle - The bundle exporting the package
Returns:
true if this package is being exported by a bundle that has been updated or uninstalled.
Throws:
java.io.IOException - if the operation fails
java.lang.IllegalArgumentException - if the package indicated does not exist

OSGi™ Enterprise
Release 5

Copyright © OSGi Alliance (2000, 2012). All Rights Reserved. Licensed under the OSGi Specification License, Version 2.0