BlueprintStateMBean (Apache Aries JMX Blueprint API 1.1.5 API)

```
public interface BlueprintStateMBean
```
This MBean provides the management interface to the OSGi Blueprint Service. This MBean also emits events that clients can use to get notified of the changes in the blueprint containers state in the framework.

Version:

$Revision: 1335419 $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUNDLE_ID` The key BUNDLE_ID, used in `BUNDLE_ID_ITEM`.
`static Item`	`BUNDLE_ID_ITEM` The item containing the Blueprint bundle id associated with this event.
`static String`	`DEPENDENCIES` The key DEPENDENCIES, used in `DEPENDENCIES_ITEM`.
`static Item`	`DEPENDENCIES_ITEM` The item containing the filters identifying the missing dependencies that caused the WAITING, GRACE_PERIOD or FAILURE event.
`static String`	`EVENT_TYPE` The key EVENT_TYPE, used in `EVENT_TYPE_ITEM`.
`static Item`	`EVENT_TYPE_ITEM` The item containing the type of this event.
`static String`	`EXCEPTION_MESSAGE` The key EXCEPTION_MESSAGE, used in `#ERROR_MESSAGE_ITEM`.
`static Item`	`EXCEPTION_MESSAGE_ITEM` The item containing the exception message that cause this FAILURE event.
`static String`	`EXTENDER_BUNDLE_ID` The key EXTENDER_BUNDLE_ID, used in `EXTENDER_BUNDLE_ID_ITEM`.
`static Item`	`EXTENDER_BUNDLE_ID_ITEM` The item containing the Blueprint extender bundle id that is generating this event.
`static String`	`OBJECTNAME` The object name for this MBean.
`static CompositeType`	`OSGI_BLUEPRINT_EVENT_TYPE` The CompositeType for a blueprint event.
`static TabularType`	`OSGI_BLUEPRINT_EVENTS_TYPE` The Tabular Type for A list of blueprint events.
`static String`	`REPLAY` The key REPLAY, used in `REPLAY_ITEM`.
`static Item`	`REPLAY_ITEM` The item containing the flag that represents whether this event is a replay event.
`static String`	`TIMESTAMP` The key TIMESTAMP, used in `TIMESTAMP_ITEM`.
`static Item`	`TIMESTAMP_ITEM` The item containing the time at which this event was created.

Method Summary

Methods
Modifier and Type	Method and Description
`long[]`	`getBlueprintBundleIds()` Returns all the blueprint bundles' IDs, which are either successfully created or not by current extender.
`CompositeData`	`getLastEvent(long bundleId)` Returns the BlueprintEvent associated with this blueprint container.
`TabularData`	`getLastEvents()` Returns all the last events associated with the blueprint bundles.

- Field Detail
  - OBJECTNAME
```
static final String OBJECTNAME
```
    The object name for this MBean.
    
    See Also:
    Constant Field Values
  - BUNDLE_ID
```
static final String BUNDLE_ID
```
    The key BUNDLE_ID, used in BUNDLE_ID_ITEM.
    
    See Also:
    Constant Field Values
  - BUNDLE_ID_ITEM
```
static final Item BUNDLE_ID_ITEM
```
    The item containing the Blueprint bundle id associated with this event. The key is BUNDLE_ID, and the type is SimpleType.LONG.
  - EXTENDER_BUNDLE_ID
```
static final String EXTENDER_BUNDLE_ID
```
    The key EXTENDER_BUNDLE_ID, used in EXTENDER_BUNDLE_ID_ITEM.
    
    See Also:
    Constant Field Values
  - EXTENDER_BUNDLE_ID_ITEM
```
static final Item EXTENDER_BUNDLE_ID_ITEM
```
    The item containing the Blueprint extender bundle id that is generating this event. The key is EXTENDER_BUNDLE_ID, and the type is SimpleType.LONG.
  - REPLAY
```
static final String REPLAY
```
    The key REPLAY, used in REPLAY_ITEM.
    
    See Also:
    Constant Field Values
  - REPLAY_ITEM
```
static final Item REPLAY_ITEM
```
    The item containing the flag that represents whether this event is a replay event. The key is REPLAY, and the type is SimpleType.BOOLEAN.
  - EVENT_TYPE
```
static final String EVENT_TYPE
```
    The key EVENT_TYPE, used in EVENT_TYPE_ITEM.
    
    See Also:
    Constant Field Values
  - EVENT_TYPE_ITEM
```
static final Item EVENT_TYPE_ITEM
```
    The item containing the type of this event. The key is EVENT_TYPE, and the type is SimpleType.STRING.
  - TIMESTAMP
```
static final String TIMESTAMP
```
    The key TIMESTAMP, used in TIMESTAMP_ITEM.
    
    See Also:
    Constant Field Values
  - TIMESTAMP_ITEM
```
static final Item TIMESTAMP_ITEM
```
    The item containing the time at which this event was created. The key is TIMESTAMP, and the type is SimpleType.LONG.
  - DEPENDENCIES
```
static final String DEPENDENCIES
```
    The key DEPENDENCIES, used in DEPENDENCIES_ITEM.
    
    See Also:
    Constant Field Values
  - DEPENDENCIES_ITEM
```
static final Item DEPENDENCIES_ITEM
```
    The item containing the filters identifying the missing dependencies that caused the WAITING, GRACE_PERIOD or FAILURE event. The key is DEPENDENCIES, and the type is JmxConstants.STRING_ARRAY_TYPE.
  - EXCEPTION_MESSAGE
```
static final String EXCEPTION_MESSAGE
```
    The key EXCEPTION_MESSAGE, used in #ERROR_MESSAGE_ITEM.
    
    See Also:
    Constant Field Values
  - EXCEPTION_MESSAGE_ITEM
```
static final Item EXCEPTION_MESSAGE_ITEM
```
    The item containing the exception message that cause this FAILURE event. The key is EXCEPTION_MESSAGE, and the type is SimpleType.STRING.
  - OSGI_BLUEPRINT_EVENT_TYPE
```
static final CompositeType OSGI_BLUEPRINT_EVENT_TYPE
```
    The CompositeType for a blueprint event. It contains the following items:
  - OSGI_BLUEPRINT_EVENTS_TYPE
```
static final TabularType OSGI_BLUEPRINT_EVENTS_TYPE
```
    The Tabular Type for A list of blueprint events. The row type is OSGI_BLUEPRINT_EVENT_TYPE.
- Method Detail
  - getLastEvent
```
CompositeData getLastEvent(long bundleId)
                           throws IOException
```
    Returns the BlueprintEvent associated with this blueprint container. The returned Composite Data is typed by OSGI_BLUEPRINT_EVENT_TYPE.
    
    Parameters:
    bundleId - The bundle id of a blueprint bundle
    
    Returns:
    the last event associated with the blueprint bundle, see OSGI_BLUEPRINT_EVENT_TYPE
    
    Throws:
    
    IOException - if the operation fails
    
    IllegalArgumentException - if the bundle is not a blueprint bundle
  - getLastEvents
```
TabularData getLastEvents()
                          throws IOException
```
    Returns all the last events associated with the blueprint bundles.
    
    Returns:
    the tabular representation of all the last events associated with the blueprint bundles see OSGI_BLUEPRINT_EVENTS_TYPE
    
    Throws:
    
    IOException - if the operation fails
  - getBlueprintBundleIds
```
long[] getBlueprintBundleIds()
                             throws IOException
```
    Returns all the blueprint bundles' IDs, which are either successfully created or not by current extender.
    
    Returns:
    the list of all the blueprint bundles's IDs (either successfully created or not by current extender)
    
    Throws:
    
    IOException - if the operation fails

Interface BlueprintStateMBean

Field Summary

Method Summary

Field Detail

OBJECTNAME

BUNDLE_ID

BUNDLE_ID_ITEM

EXTENDER_BUNDLE_ID

EXTENDER_BUNDLE_ID_ITEM

REPLAY

REPLAY_ITEM

EVENT_TYPE

EVENT_TYPE_ITEM

TIMESTAMP

TIMESTAMP_ITEM

DEPENDENCIES

DEPENDENCIES_ITEM

EXCEPTION_MESSAGE

EXCEPTION_MESSAGE_ITEM

OSGI_BLUEPRINT_EVENT_TYPE

OSGI_BLUEPRINT_EVENTS_TYPE

Method Detail

getLastEvent

getLastEvents

getBlueprintBundleIds