|
OSGi™ Service Platform Release 4 Version 4.2 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BundleStateMBean
This MBean represents the Bundle state of the framework. This MBean also emits events that clients can use to get notified of the changes in the bundle state of the framework.
Field Summary | |
---|---|
static java.lang.String |
ACTIVE
Constant ACTIVE for the STATE |
static javax.management.openmbean.CompositeType |
BUNDLE_EVENT_TYPE
The Composite Type that represents a bundle event. |
static javax.management.openmbean.CompositeType |
BUNDLE_TYPE
The Composite Type that represents a bundle. |
static javax.management.openmbean.TabularType |
BUNDLES_TYPE
The Tabular Type for a list of bundles. |
static java.lang.String |
EVENT
The key EVENT, used in EVENT_ITEM . |
static Item |
EVENT_ITEM
The item containing the event type. |
static java.lang.String |
EXPORTED_PACKAGES
The key EXPORTED_PACKAGES, used in EXPORTED_PACKAGES_ITEM . |
static Item |
EXPORTED_PACKAGES_ITEM
The item containing the exported package names in BUNDLE_TYPE
.The key is EXPORTED_PACKAGES and the the type is
JmxConstants.STRING_ARRAY_TYPE . |
static java.lang.String |
FRAGMENT
The key FRAGMENT, used in FRAGMENT_ITEM . |
static Item |
FRAGMENT_ITEM
The item containing the fragment status in BUNDLE_TYPE . |
static java.lang.String |
FRAGMENTS
The key FRAGMENTS, used in FRAGMENTS_ITEM . |
static Item |
FRAGMENTS_ITEM
The item containing the list of fragments the bundle is host to in BUNDLE_TYPE . |
static javax.management.openmbean.CompositeType |
HEADER_TYPE
The Composite Type describing an entry in bundle headers. |
static java.lang.String |
HEADERS
The key HEADERS, used in HEADERS_ITEM . |
static Item |
HEADERS_ITEM
The item containing the bundle headers in BUNDLE_TYPE . |
static javax.management.openmbean.TabularType |
HEADERS_TYPE
The Tabular Type describing the type of the Tabular Data value that is returned from getHeaders(long) method. |
static java.lang.String |
HOSTS
The key HOSTS, used in HOSTS_ITEM . |
static Item |
HOSTS_ITEM
The item containing the bundle identifiers representing the hosts in BUNDLE_TYPE . |
static java.lang.String |
IDENTIFIER
The key IDENTIFIER, used in IDENTIFIER_ITEM . |
static Item |
IDENTIFIER_ITEM
The item containing the bundle identifier in BUNDLE_TYPE . |
static java.lang.String |
IMPORTED_PACKAGES
The key IMPORTED_PACKAGES, used in EXPORTED_PACKAGES_ITEM . |
static Item |
IMPORTED_PACKAGES_ITEM
The item containing the imported package names in BUNDLE_TYPE
.The key is IMPORTED_PACKAGES and the the type is
JmxConstants.STRING_ARRAY_TYPE . |
static java.lang.String |
INSTALLED
Constant INSTALLED for the STATE |
static java.lang.String |
KEY
The key KEY, used in KEY_ITEM . |
static Item |
KEY_ITEM
The item describing the key of a bundle header entry. |
static java.lang.String |
LAST_MODIFIED
The key LAST_MODIFIED, used in LAST_MODIFIED_ITEM . |
static Item |
LAST_MODIFIED_ITEM
The item containing the last modified time in the BUNDLE_TYPE . |
static java.lang.String |
LOCATION
The key LOCATION, used in LOCATION_ITEM . |
static Item |
LOCATION_ITEM
The item containing the bundle location in BUNDLE_TYPE . |
static java.lang.String |
OBJECTNAME
The Object Name for a Bundle State MBean. |
static java.lang.String |
PERSISTENTLY_STARTED
The key PERSISTENTLY_STARTED, used in PERSISTENTLY_STARTED_ITEM . |
static Item |
PERSISTENTLY_STARTED_ITEM
The item containing the indication of persistently started in BUNDLE_TYPE . |
static java.lang.String |
REGISTERED_SERVICES
The key REGISTERED_SERVICES, used in REGISTERED_SERVICES_ITEM . |
static Item |
REGISTERED_SERVICES_ITEM
The item containing the registered services of the bundle in BUNDLE_TYPE . |
static java.lang.String |
REMOVAL_PENDING
The key REMOVAL_PENDING, used in REMOVAL_PENDING_ITEM . |
static Item |
REMOVAL_PENDING_ITEM
The item containing the indication of removal pending in BUNDLE_TYPE . |
static java.lang.String |
REQUIRED
The key REQUIRED, used in REQUIRED_ITEM . |
static java.lang.String |
REQUIRED_BUNDLES
The key REQUIRED_BUNDLES, used in REQUIRED_BUNDLES_ITEM . |
static Item |
REQUIRED_BUNDLES_ITEM
The item containing the required bundles in BUNDLE_TYPE . |
static Item |
REQUIRED_ITEM
The item containing the required status in BUNDLE_TYPE . |
static java.lang.String |
REQUIRING_BUNDLES
The key REQUIRING_BUNDLES, used in REQUIRING_BUNDLES_ITEM . |
static Item |
REQUIRING_BUNDLES_ITEM
The item containing the bundles requiring this bundle in BUNDLE_TYPE . |
static java.lang.String |
RESOLVED
Constant RESOLVED for the STATE |
static java.lang.String |
SERVICES_IN_USE
The key SERVICES_IN_USE, used in SERVICES_IN_USE_ITEM . |
static Item |
SERVICES_IN_USE_ITEM
The item containing the services in use by this bundle in BUNDLE_TYPE . |
static java.lang.String |
START_LEVEL
The key START_LEVEL, used in START_LEVEL_ITEM . |
static Item |
START_LEVEL_ITEM
The item containing the start level in BUNDLE_TYPE . |
static java.lang.String |
STARTING
Constant STARTING for the STATE |
static java.lang.String |
STATE
The key STATE, used in STATE_ITEM . |
static Item |
STATE_ITEM
The item containing the bundle state in BUNDLE_TYPE . |
static java.lang.String |
STOPPING
Constant STOPPING for the STATE |
static java.lang.String |
SYMBOLIC_NAME
The key SYMBOLIC_NAME, used in SYMBOLIC_NAME_ITEM . |
static Item |
SYMBOLIC_NAME_ITEM
The item containing the symbolic name in BUNDLE_TYPE . |
static java.lang.String |
UNINSTALLED
Constant UNINSTALLED for the STATE |
static java.lang.String |
UNKNOWN
Constant UNKNOWN for the STATE |
static java.lang.String |
VALUE
The key VALUE, used in VALUE_ITEM . |
static Item |
VALUE_ITEM
The item describing the value of a bundle header entry. |
static java.lang.String |
VERSION
The key VERSION, used in VERSION_ITEM . |
static Item |
VERSION_ITEM
The item containing the symbolic name in BUNDLE_TYPE . |
Method Summary | |
---|---|
java.lang.String[] |
getExportedPackages(long bundleId)
Answer the list of exported packages for this bundle. |
long[] |
getFragments(long bundleId)
Answer the list of the bundle ids of the fragments associated with this bundle |
javax.management.openmbean.TabularData |
getHeaders(long bundleId)
Answer the headers for the bundle uniquely identified by the bundle id. |
long[] |
getHosts(long fragment)
Answer the list of bundle ids of the bundles which host a fragment |
java.lang.String[] |
getImportedPackages(long bundleId)
Answer the array of the packages imported by this bundle |
long |
getLastModified(long bundleId)
Answer the last modified time of a bundle |
java.lang.String |
getLocation(long bundleId)
Answer the location of the bundle. |
long[] |
getRegisteredServices(long bundleId)
Answer the list of service identifiers representing the services this bundle exports |
long[] |
getRequiredBundles(long bundleIdentifier)
Answer the list of identifiers of the bundles this bundle depends upon |
long[] |
getRequiringBundles(long bundleIdentifier)
Answer the list of identifiers of the bundles which require this bundle |
long[] |
getServicesInUse(long bundleIdentifier)
Answer the list of service identifiers which refer to the the services this bundle is using |
int |
getStartLevel(long bundleId)
Answer the start level of the bundle |
java.lang.String |
getState(long bundleId)
Answer the symbolic name of the state of the bundle |
java.lang.String |
getSymbolicName(long bundleId)
Answer the symbolic name of the bundle |
java.lang.String |
getVersion(long bundleId)
Answer the location of the bundle. |
boolean |
isFragment(long bundleId)
Answer whether the bundle is a fragment or not |
boolean |
isPersistentlyStarted(long bundleId)
Answer if the bundle is persistently started when its start level is reached |
boolean |
isRemovalPending(long bundleId)
Answer true if the bundle is pending removal |
boolean |
isRequired(long bundleId)
Answer true if the bundle is required by another bundle |
javax.management.openmbean.TabularData |
listBundles()
Answer the bundle state of the system in tabular form. |
Field Detail |
---|
static final java.lang.String OBJECTNAME
static final java.lang.String KEY
KEY_ITEM
.
static final Item KEY_ITEM
KEY
and the type is SimpleType.STRING
.
static final java.lang.String VALUE
VALUE_ITEM
.
static final Item VALUE_ITEM
VALUE
and the type is SimpleType.STRING
.
static final javax.management.openmbean.CompositeType HEADER_TYPE
KEY_ITEM
and VALUE_ITEM
.
static final javax.management.openmbean.TabularType HEADERS_TYPE
getHeaders(long)
method. The primary item is
KEY_ITEM
.
static final java.lang.String LOCATION
LOCATION_ITEM
.
static final Item LOCATION_ITEM
BUNDLE_TYPE
. The key
is LOCATION
and the the type is SimpleType.STRING
.
static final java.lang.String IDENTIFIER
IDENTIFIER_ITEM
.
static final Item IDENTIFIER_ITEM
BUNDLE_TYPE
. The
key is IDENTIFIER
and the the type is SimpleType.LONG
.
static final java.lang.String SYMBOLIC_NAME
SYMBOLIC_NAME_ITEM
.
static final Item SYMBOLIC_NAME_ITEM
BUNDLE_TYPE
. The key is
SYMBOLIC_NAME
and the the type is SimpleType.STRING
.
static final java.lang.String VERSION
VERSION_ITEM
.
static final Item VERSION_ITEM
BUNDLE_TYPE
. The key is
SYMBOLIC_NAME
and the the type is SimpleType.STRING
.
static final java.lang.String START_LEVEL
START_LEVEL_ITEM
.
static final Item START_LEVEL_ITEM
BUNDLE_TYPE
. The key is
START_LEVEL
and the the type is SimpleType.INTEGER
.
static final java.lang.String STATE
STATE_ITEM
.
static final java.lang.String INSTALLED
STATE
static final java.lang.String RESOLVED
STATE
static final java.lang.String STARTING
STATE
static final java.lang.String ACTIVE
STATE
static final java.lang.String STOPPING
STATE
static final java.lang.String UNINSTALLED
STATE
static final java.lang.String UNKNOWN
STATE
static final Item STATE_ITEM
BUNDLE_TYPE
. The key is
STATE
and the the type is SimpleType.STRING
. The
returned values must be one of the following strings:
static final java.lang.String LAST_MODIFIED
LAST_MODIFIED_ITEM
.
static final Item LAST_MODIFIED_ITEM
BUNDLE_TYPE
.
The key is LAST_MODIFIED
and the the type is
SimpleType.LONG
.
static final java.lang.String PERSISTENTLY_STARTED
PERSISTENTLY_STARTED_ITEM
.
static final Item PERSISTENTLY_STARTED_ITEM
BUNDLE_TYPE
. The key is PERSISTENTLY_STARTED
and the
the type is SimpleType.BOOLEAN
.
static final java.lang.String REMOVAL_PENDING
REMOVAL_PENDING_ITEM
.
static final Item REMOVAL_PENDING_ITEM
BUNDLE_TYPE
. The key is REMOVAL_PENDING
and the type is
SimpleType.BOOLEAN
.
static final java.lang.String REQUIRED
REQUIRED_ITEM
.
static final Item REQUIRED_ITEM
BUNDLE_TYPE
. The key
is REQUIRED
and the the type is SimpleType.BOOLEAN
.
static final java.lang.String FRAGMENT
FRAGMENT_ITEM
.
static final Item FRAGMENT_ITEM
BUNDLE_TYPE
. The key
is FRAGMENT
and the the type is SimpleType.BOOLEAN
.
static final java.lang.String REGISTERED_SERVICES
REGISTERED_SERVICES_ITEM
.
static final Item REGISTERED_SERVICES_ITEM
BUNDLE_TYPE
. The key is REGISTERED_SERVICES
and the the
type is JmxConstants.LONG_ARRAY_TYPE
.
static final java.lang.String SERVICES_IN_USE
SERVICES_IN_USE_ITEM
.
static final Item SERVICES_IN_USE_ITEM
BUNDLE_TYPE
. The key is SERVICES_IN_USE
and the the
type is JmxConstants.LONG_ARRAY_TYPE
.
static final java.lang.String HEADERS
HEADERS_ITEM
.
static final Item HEADERS_ITEM
BUNDLE_TYPE
. The key
is HEADERS
and the the type is HEADERS_TYPE
.
static final java.lang.String EXPORTED_PACKAGES
EXPORTED_PACKAGES_ITEM
.
static final Item EXPORTED_PACKAGES_ITEM
BUNDLE_TYPE
.The key is EXPORTED_PACKAGES
and the the type is
JmxConstants.STRING_ARRAY_TYPE
.
static final java.lang.String IMPORTED_PACKAGES
EXPORTED_PACKAGES_ITEM
.
static final Item IMPORTED_PACKAGES_ITEM
BUNDLE_TYPE
.The key is IMPORTED_PACKAGES
and the the type is
JmxConstants.STRING_ARRAY_TYPE
.
static final java.lang.String FRAGMENTS
FRAGMENTS_ITEM
.
static final Item FRAGMENTS_ITEM
BUNDLE_TYPE
. The key is FRAGMENTS
and the type is
JmxConstants.LONG_ARRAY_TYPE
.
static final java.lang.String HOSTS
HOSTS_ITEM
.
static final Item HOSTS_ITEM
BUNDLE_TYPE
. The key is HOSTS
and the type is
JmxConstants.LONG_ARRAY_TYPE
static final java.lang.String REQUIRED_BUNDLES
REQUIRED_BUNDLES_ITEM
.
static final Item REQUIRED_BUNDLES_ITEM
BUNDLE_TYPE
. The key
is REQUIRED_BUNDLES
and the type is
JmxConstants.LONG_ARRAY_TYPE
static final java.lang.String REQUIRING_BUNDLES
REQUIRING_BUNDLES_ITEM
.
static final Item REQUIRING_BUNDLES_ITEM
BUNDLE_TYPE
. The key is REQUIRING_BUNDLES
and the type
is JmxConstants.LONG_ARRAY_TYPE
static final java.lang.String EVENT
EVENT_ITEM
.
static final Item EVENT_ITEM
EVENT
and the type is SimpleType.INTEGER
static final javax.management.openmbean.CompositeType BUNDLE_EVENT_TYPE
static final javax.management.openmbean.CompositeType BUNDLE_TYPE
EXPORTED_PACKAGES
FRAGMENT
FRAGMENTS
HEADERS
HOSTS
IDENTIFIER
IMPORTED_PACKAGES
LAST_MODIFIED
LOCATION
PERSISTENTLY_STARTED
REGISTERED_SERVICES
REMOVAL_PENDING
REQUIRED
REQUIRED_BUNDLES
REQUIRING_BUNDLES
START_LEVEL
STATE
SERVICES_IN_USE
SYMBOLIC_NAME
VERSION
BUNDLES_TYPE
.
static final javax.management.openmbean.TabularType BUNDLES_TYPE
BUNDLE_TYPE
.
Method Detail |
---|
long[] getRequiredBundles(long bundleIdentifier) throws java.io.IOException
bundleIdentifier
- the bundle identifier
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjavax.management.openmbean.TabularData listBundles() throws java.io.IOException
BUNDLES_TYPE
.
java.io.IOException
java.lang.String[] getExportedPackages(long bundleId) throws java.io.IOException
bundleId
-
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong[] getFragments(long bundleId) throws java.io.IOException
bundleId
-
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjavax.management.openmbean.TabularData getHeaders(long bundleId) throws java.io.IOException
HEADERS_TYPE
.
bundleId
- the unique identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong[] getHosts(long fragment) throws java.io.IOException
fragment
- the bundle id of the fragment
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjava.lang.String[] getImportedPackages(long bundleId) throws java.io.IOException
bundleId
- the bundle identifier
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong getLastModified(long bundleId) throws java.io.IOException
bundleId
- the unique identifier of a bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong[] getRegisteredServices(long bundleId) throws java.io.IOException
bundleId
- the bundle identifier
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong[] getRequiringBundles(long bundleIdentifier) throws java.io.IOException
bundleIdentifier
- the bundle identifier
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existlong[] getServicesInUse(long bundleIdentifier) throws java.io.IOException
bundleIdentifier
- the bundle identifier
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existint getStartLevel(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjava.lang.String getState(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjava.lang.String getSymbolicName(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existboolean isPersistentlyStarted(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existboolean isFragment(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existboolean isRemovalPending(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existboolean isRequired(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjava.lang.String getLocation(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not existjava.lang.String getVersion(long bundleId) throws java.io.IOException
bundleId
- the identifier of the bundle
java.io.IOException
- if the operation fails
java.lang.IllegalArgumentException
- if the bundle indicated does not exist
|
OSGi™ Service Platform Release 4 Version 4.2 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |