org.osgi.jmx.framework.wiring

Interface BundleWiringStateMBean

public interface BundleWiringStateMBean

This MBean represents the bundle wiring state.

It can be used to retrieve the declared capabilities, declared requirements, and wiring for the current and past revisions of bundles.

"ThreadSafe"

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTES The key of ATTRIBUTES_ITEM.
static Item	ATTRIBUTES_ITEM The item containing the attributes of a capability or requirement.
static TabularType	ATTRIBUTES_TYPE The Tabular Type that holds the attributes for a capability or requirements.
static String	BUNDLE_CAPABILITY The key of BUNDLE_CAPABILITY_ITEM.
static Item	BUNDLE_CAPABILITY_ITEM The item containing a capability for a bundle in BUNDLE_WIRE_TYPE.
static CompositeType	BUNDLE_CAPABILITY_TYPE The Composite Type that represents the capability of a bundle.
static String	BUNDLE_ID The key of BUNDLE_ID_ITEM.
static Item	BUNDLE_ID_ITEM The item containing a bundle ID.
static String	BUNDLE_REQUIREMENT The key of BUNDLE_REQUIREMENT_ITEM.
static Item	BUNDLE_REQUIREMENT_ITEM The item containing a requirement for a bundle in BUNDLE_WIRE_TYPE.
static CompositeType	BUNDLE_REQUIREMENT_TYPE The Composite Type that represents the requirement of a bundle.
static String	BUNDLE_REVISION_ID The key of BUNDLE_REVISION_ID_ITEM.
static Item	BUNDLE_REVISION_ID_ITEM The item containing a bundle revision ID.
static CompositeType	BUNDLE_WIRE_TYPE The Composite type that represents a bundle wire describing the live association between a provider of a capability and a requirer of the corresponding requirement.
static ArrayType	BUNDLE_WIRES_TYPE_ARRAY An array of BUNDLE_WIRE_TYPEs.
static CompositeType	BUNDLE_WIRING_TYPE The Composite Type that represents a bundle wiring.
static TabularType	BUNDLES_WIRING_TYPE The Tabular Type to hold the wiring of a number of bundles.
static String	CAPABILITIES The key of CAPABILITIES_ITEM.
static Item	CAPABILITIES_ITEM The item containing the capabilities in REVISION_CAPABILITIES_TYPE and BUNDLE_WIRING_TYPE.
static ArrayType	CAPABILITY_TYPE_ARRAY An array of BUNDLE_CAPABILITY_TYPEs.
static CompositeType	DIRECTIVE_TYPE The Composite Type that represents a directive for a capability or requirement.
static String	DIRECTIVES The key of DIRECTIVES_ITEM.
static Item	DIRECTIVES_ITEM The item containing the directives of a capability or requirement.
static TabularType	DIRECTIVES_TYPE The Tabular Type that holds the directives for a capability or requirement.
static String	KEY The key of KEY_ITEM.
static Item	KEY_ITEM The item containing the key of a capability or requirement directive.
static String	NAMESPACE The key of NAMESPACE_ITEM.
static Item	NAMESPACE_ITEM The item containing the namespace for a capability or requirement.
static String	OBJECTNAME The Object Name prefix for this mbean.
static String	PROVIDED_WIRES The key of PROVIDED_WIRES_ITEM.
static Item	PROVIDED_WIRES_ITEM The item containing the provided wires in BUNDLE_WIRING_TYPE.
static String	PROVIDER_BUNDLE_ID The key of PROVIDER_BUNDLE_ID_ITEM.
static Item	PROVIDER_BUNDLE_ID_ITEM The item containing the provider bundle ID in BUNDLE_WIRE_TYPE.
static String	PROVIDER_BUNDLE_REVISION_ID The key of PROVIDER_BUNDLE_REVISION_ID_ITEM.
static Item	PROVIDER_BUNDLE_REVISION_ID_ITEM The local ID of a provider revision in BUNDLE_WIRE_TYPE.
static String	REQUIRED_WIRES The key of REQUIRED_WIRES_ITEM.
static Item	REQUIRED_WIRES_ITEM The item containing the required wires in BUNDLE_WIRING_TYPE.
static ArrayType	REQUIREMENT_TYPE_ARRAY An array of BUNDLE_REQUIREMENT_TYPEs.
static String	REQUIREMENTS The key of REQUIREMENTS_ITEM.
static Item	REQUIREMENTS_ITEM The item containing the requirements in REVISION_REQUIREMENTS_TYPE and BUNDLE_WIRING_TYPE.
static String	REQUIRER_BUNDLE_ID The key of REQUIRER_BUNDLE_ID_ITEM.
static Item	REQUIRER_BUNDLE_ID_ITEM The item containing the requirer bundle ID in BUNDLE_WIRE_TYPE.
static String	REQUIRER_BUNDLE_REVISION_ID The key of REQUIRER_BUNDLE_REVISION_ID_ITEM.
static Item	REQUIRER_BUNDLE_REVISION_ID_ITEM The local ID of a requirer revision in BUNDLE_WIRE_TYPE.
static CompositeType	REVISION_CAPABILITIES_TYPE The Composite Type that represents the capabilities for a revision.
static CompositeType	REVISION_REQUIREMENTS_TYPE The Composite Type that represents the requirements of a revision.
static TabularType	REVISIONS_CAPABILITIES_TYPE The Tabular Type that holds the capabilities of a revision.
static TabularType	REVISIONS_REQUIREMENTS_TYPE The Tabular Type that hold the requirements of a revision.
static String	VALUE The key of VALUE.
static Item	VALUE_ITEM The item containing the value of a capability or requirement directive.

Method Summary

Methods

Modifier and Type	Method and Description
CompositeData[]	getCurrentRevisionDeclaredCapabilities(long bundleId, String namespace) Returns the capabilities for the current bundle revision.
CompositeData[]	getCurrentRevisionDeclaredRequirements(long bundleId, String namespace) Returns the requirements for the current bundle revision.
CompositeData	getCurrentWiring(long bundleId, String namespace) Returns the bundle wiring for the current bundle revision.
TabularData	getCurrentWiringClosure(long rootBundleId, String namespace) Returns the bundle wiring closure for the current revision of the specified bundle.
TabularData	getRevisionsDeclaredCapabilities(long bundleId, String namespace) Returns the capabilities for all revisions of the bundle.
TabularData	getRevisionsDeclaredRequirements(long bundleId, String namespace) Returns the requirements for all revisions of the bundle.
TabularData	getRevisionsWiring(long bundleId, String namespace) Returns the bundle wirings for all revisions of the bundle.
TabularData	getRevisionsWiringClosure(long rootBundleId, String namespace) Returns the bundle wiring closure for all revisions of the specified bundle.

Field Detail

OBJECTNAME

static final String OBJECTNAME

The Object Name prefix for this mbean. The full object name also contains the framework name and uuid as properties.

See Also:

Constant Field Values

KEY

static final String KEY

The key of KEY_ITEM.

See Also:

Constant Field Values

KEY_ITEM

static final Item KEY_ITEM

The item containing the key of a capability or requirement directive. Used in DIRECTIVE_TYPE. The key is KEY and the type is a String.

VALUE

static final String VALUE

The key of VALUE.

See Also:

Constant Field Values

VALUE_ITEM

static final Item VALUE_ITEM

The item containing the value of a capability or requirement directive. Used in DIRECTIVE_TYPE. They key is VALUE and the type is a String.

DIRECTIVE_TYPE

static final CompositeType DIRECTIVE_TYPE

The Composite Type that represents a directive for a capability or requirement. The composite consists of:

• KEY
• VALUE

DIRECTIVES_TYPE

static final TabularType DIRECTIVES_TYPE

The Tabular Type that holds the directives for a capability or requirement. The row type is DIRECTIVE_TYPE and the index is KEY.

DIRECTIVES

static final String DIRECTIVES

The key of DIRECTIVES_ITEM.

See Also:

Constant Field Values

DIRECTIVES_ITEM

static final Item DIRECTIVES_ITEM

The item containing the directives of a capability or requirement. Used in BUNDLE_REQUIREMENT_TYPE and BUNDLE_CAPABILITY_TYPE. The key is DIRECTIVES and the type is DIRECTIVES_TYPE.

ATTRIBUTES_TYPE

static final TabularType ATTRIBUTES_TYPE

The Tabular Type that holds the attributes for a capability or requirements. The row type is JmxConstants.PROPERTY_TYPE and the index is JmxConstants.KEY.

ATTRIBUTES

static final String ATTRIBUTES

The key of ATTRIBUTES_ITEM.

See Also:

Constant Field Values

ATTRIBUTES_ITEM

static final Item ATTRIBUTES_ITEM

The item containing the attributes of a capability or requirement. Used in BUNDLE_REQUIREMENT_TYPE and BUNDLE_CAPABILITY_TYPE. The key is ATTRIBUTES and the type is ATTRIBUTES_TYPE.

NAMESPACE

static final String NAMESPACE

The key of NAMESPACE_ITEM.

See Also:

Constant Field Values

NAMESPACE_ITEM

static final Item NAMESPACE_ITEM

The item containing the namespace for a capability or requirement. Used in BUNDLE_REQUIREMENT_TYPE and BUNDLE_CAPABILITY_TYPE. The key is NAMESPACE and the type is a String.

BUNDLE_REQUIREMENT_TYPE

static final CompositeType BUNDLE_REQUIREMENT_TYPE

The Composite Type that represents the requirement of a bundle. The composite consists of:

• NAMESPACE
• ATTRIBUTES
• DIRECTIVES

BUNDLE_CAPABILITY_TYPE

static final CompositeType BUNDLE_CAPABILITY_TYPE

The Composite Type that represents the capability of a bundle. The composite consists of:

• NAMESPACE
• ATTRIBUTES
• DIRECTIVES

PROVIDER_BUNDLE_ID

static final String PROVIDER_BUNDLE_ID

The key of PROVIDER_BUNDLE_ID_ITEM.

See Also:

Constant Field Values

PROVIDER_BUNDLE_ID_ITEM

static final Item PROVIDER_BUNDLE_ID_ITEM

The item containing the provider bundle ID in BUNDLE_WIRE_TYPE. The key is PROVIDER_BUNDLE_ID and the type is a long.

REQUIRER_BUNDLE_ID

static final String REQUIRER_BUNDLE_ID

The key of REQUIRER_BUNDLE_ID_ITEM.

See Also:

Constant Field Values

REQUIRER_BUNDLE_ID_ITEM

static final Item REQUIRER_BUNDLE_ID_ITEM

The item containing the requirer bundle ID in BUNDLE_WIRE_TYPE. The key is REQUIRER_BUNDLE_ID and the type is long.

BUNDLE_REQUIREMENT

static final String BUNDLE_REQUIREMENT

The key of BUNDLE_REQUIREMENT_ITEM.

See Also:

Constant Field Values

BUNDLE_REQUIREMENT_ITEM

static final Item BUNDLE_REQUIREMENT_ITEM

The item containing a requirement for a bundle in BUNDLE_WIRE_TYPE. The key is BUNDLE_REQUIREMENT and the type is BUNDLE_REQUIREMENT_TYPE.

BUNDLE_CAPABILITY

static final String BUNDLE_CAPABILITY

The key of BUNDLE_CAPABILITY_ITEM.

See Also:

Constant Field Values

BUNDLE_CAPABILITY_ITEM

static final Item BUNDLE_CAPABILITY_ITEM

The item containing a capability for a bundle in BUNDLE_WIRE_TYPE. The key is BUNDLE_CAPABILITY and the type is BUNDLE_CAPABILITY_TYPE.

PROVIDER_BUNDLE_REVISION_ID

static final String PROVIDER_BUNDLE_REVISION_ID

The key of PROVIDER_BUNDLE_REVISION_ID_ITEM.

See Also:

Constant Field Values

PROVIDER_BUNDLE_REVISION_ID_ITEM

static final Item PROVIDER_BUNDLE_REVISION_ID_ITEM

The local ID of a provider revision in BUNDLE_WIRE_TYPE. This ID is local to the result where it resides and has no defined meaning across multiple invocations. The key is PROVIDER_BUNDLE_REVISION_ID and the type is an int.

REQUIRER_BUNDLE_REVISION_ID

static final String REQUIRER_BUNDLE_REVISION_ID

The key of REQUIRER_BUNDLE_REVISION_ID_ITEM.

See Also:

Constant Field Values

REQUIRER_BUNDLE_REVISION_ID_ITEM

static final Item REQUIRER_BUNDLE_REVISION_ID_ITEM

The local ID of a requirer revision in BUNDLE_WIRE_TYPE. This ID is local to the result where it resides and has no defined meaning across multiple invocations. The key is REQUIRER_BUNDLE_REVISION_ID and the type is an int.

BUNDLE_WIRE_TYPE

static final CompositeType BUNDLE_WIRE_TYPE

The Composite type that represents a bundle wire describing the live association between a provider of a capability and a requirer of the corresponding requirement.

The composite consists of:

• BUNDLE_REQUIREMENT
• BUNDLE_CAPABILITY
• PROVIDER_BUNDLE_ID
• PROVIDER_BUNDLE_REVISION_ID
• REQUIRER_BUNDLE_ID
• REQUIRER_BUNDLE_REVISION_ID

BUNDLE_WIRES_TYPE_ARRAY

static final ArrayType BUNDLE_WIRES_TYPE_ARRAY

An array of BUNDLE_WIRE_TYPEs.

BUNDLE_REVISION_ID

static final String BUNDLE_REVISION_ID

The key of BUNDLE_REVISION_ID_ITEM.

See Also:

Constant Field Values

BUNDLE_REVISION_ID_ITEM

static final Item BUNDLE_REVISION_ID_ITEM

The item containing a bundle revision ID. A bundle revision ID is always local to the result of a JMX invocation and do not have a defined meaning across invocation calls. They are used where a result can potentially contain multiple revisions of the same bundle. The key is BUNDLE_REVISION_ID and the type is an integer.

BUNDLE_ID

static final String BUNDLE_ID

The key of BUNDLE_ID_ITEM.

See Also:

Constant Field Values

BUNDLE_ID_ITEM

static final Item BUNDLE_ID_ITEM

The item containing a bundle ID. They key is BUNDLE_ID and the type is a long.

REQUIREMENT_TYPE_ARRAY

static final ArrayType REQUIREMENT_TYPE_ARRAY

An array of BUNDLE_REQUIREMENT_TYPEs.

CAPABILITY_TYPE_ARRAY

static final ArrayType CAPABILITY_TYPE_ARRAY

An array of BUNDLE_CAPABILITY_TYPEs.

REQUIREMENTS

static final String REQUIREMENTS

The key of REQUIREMENTS_ITEM.

See Also:

Constant Field Values

REQUIREMENTS_ITEM

static final Item REQUIREMENTS_ITEM

The item containing the requirements in REVISION_REQUIREMENTS_TYPE and BUNDLE_WIRING_TYPE. The key is REQUIREMENTS and the type is REQUIREMENT_TYPE_ARRAY.

REVISION_REQUIREMENTS_TYPE

static final CompositeType REVISION_REQUIREMENTS_TYPE

The Composite Type that represents the requirements of a revision. The composite consists of:

• BUNDLE_REVISION_ID
• REQUIREMENTS

REVISIONS_REQUIREMENTS_TYPE

static final TabularType REVISIONS_REQUIREMENTS_TYPE

The Tabular Type that hold the requirements of a revision. The row type is REVISION_REQUIREMENTS_TYPE and the index is BUNDLE_REVISION_ID.

CAPABILITIES

static final String CAPABILITIES

The key of CAPABILITIES_ITEM.

See Also:

Constant Field Values

CAPABILITIES_ITEM

static final Item CAPABILITIES_ITEM

The item containing the capabilities in REVISION_CAPABILITIES_TYPE and BUNDLE_WIRING_TYPE. The key is CAPABILITIES and the type is CAPABILITY_TYPE_ARRAY.

REVISION_CAPABILITIES_TYPE

static final CompositeType REVISION_CAPABILITIES_TYPE

The Composite Type that represents the capabilities for a revision. The composite consists of:

• BUNDLE_REVISION_ID
• CAPABILITIES

REVISIONS_CAPABILITIES_TYPE

static final TabularType REVISIONS_CAPABILITIES_TYPE

The Tabular Type that holds the capabilities of a revision. The row type is REVISION_CAPABILITIES_TYPE and the index is BUNDLE_REVISION_ID.

PROVIDED_WIRES

static final String PROVIDED_WIRES

The key of PROVIDED_WIRES_ITEM.

See Also:

Constant Field Values

PROVIDED_WIRES_ITEM

static final Item PROVIDED_WIRES_ITEM

The item containing the provided wires in BUNDLE_WIRING_TYPE. The key is PROVIDED_WIRES and the type is BUNDLE_WIRES_TYPE_ARRAY.

REQUIRED_WIRES

static final String REQUIRED_WIRES

The key of REQUIRED_WIRES_ITEM.

See Also:

Constant Field Values

REQUIRED_WIRES_ITEM

static final Item REQUIRED_WIRES_ITEM

The item containing the required wires in BUNDLE_WIRING_TYPE. The key is REQUIRED_WIRES and the type is BUNDLE_WIRES_TYPE_ARRAY.

BUNDLE_WIRING_TYPE

static final CompositeType BUNDLE_WIRING_TYPE

The Composite Type that represents a bundle wiring. The composite consists of:

• BUNDLE_ID
• BUNDLE_REVISION_ID
• REQUIREMENTS
• CAPABILITIES
• REQUIRED_WIRES
• PROVIDED_WIRES

BUNDLES_WIRING_TYPE

static final TabularType BUNDLES_WIRING_TYPE

The Tabular Type to hold the wiring of a number of bundles. The row type is BUNDLE_WIRING_TYPE and the index is the combination of the BUNDLE_ID and the BUNDLE_REVISION_ID.

Method Detail

getCurrentRevisionDeclaredRequirements

CompositeData[] getCurrentRevisionDeclaredRequirements(long bundleId,
                                                     String namespace)
                                                       throws IOException,
                                                              JMException

Returns the requirements for the current bundle revision.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the requirements to be returned by this operation.

Returns:

the declared requirements for the current revision of bundleId and namespace.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of the CompositeData.

getCurrentRevisionDeclaredCapabilities

CompositeData[] getCurrentRevisionDeclaredCapabilities(long bundleId,
                                                     String namespace)
                                                       throws IOException,
                                                              JMException

Returns the capabilities for the current bundle revision.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the capabilities to be returned by this operation.

Returns:

the declared capabilities for the current revision of bundleId and namespace.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of the CompositeData.

getCurrentWiring

CompositeData getCurrentWiring(long bundleId,
                             String namespace)
                               throws IOException,
                                      JMException

Returns the bundle wiring for the current bundle revision.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the requirements and capabilities for which to return information.

Returns:

the wiring information for the current revision of bundleId and namespace.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of the CompositeData.

getCurrentWiringClosure

TabularData getCurrentWiringClosure(long rootBundleId,
                                  String namespace)
                                    throws IOException,
                                           JMException

Returns the bundle wiring closure for the current revision of the specified bundle. The wiring closure contains all the wirings from the root bundle revision to all bundle revisions it is wired to and all their transitive wirings.

Parameters:

rootBundleId - the root bundle of the closure.

namespace - The namespace of the requirements and capabilities for which to return information.

Returns:

a tabular representation of all the wirings in the closure. The bundle revision IDs only have meaning in the context of the current result. The revision of the rootBundle is set to 0. Therefore the root bundle of the closure can be looked up in the table by its bundle ID and revision 0.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of the TabularData.

getRevisionsDeclaredRequirements

TabularData getRevisionsDeclaredRequirements(long bundleId,
                                           String namespace)
                                             throws IOException,
                                                    JMException

Returns the requirements for all revisions of the bundle.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the requirements to be returned by this operation.

Returns:

the declared requirements for all revisions of bundleId.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of TabularData. The requirements are in no particular order, and may change in subsequent calls to this operation.

getRevisionsDeclaredCapabilities

TabularData getRevisionsDeclaredCapabilities(long bundleId,
                                           String namespace)
                                             throws IOException,
                                                    JMException

Returns the capabilities for all revisions of the bundle.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the capabilities to be returned by this operation.

Returns:

the declared capabilities for all revisions of bundleId

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of TabularData. The capabilities are in no particular order, and may change in subsequent calls to this operation.

getRevisionsWiring

TabularData getRevisionsWiring(long bundleId,
                             String namespace)
                               throws IOException,
                                      JMException

Returns the bundle wirings for all revisions of the bundle.

Parameters:

bundleId - The bundle ID.

namespace - The namespace of the requirements and capabilities for which to return information.

Returns:

the wiring information for all revisions of bundleId and namespace.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of TabularData. The bundle wirings are in no particular order, and may change in subsequent calls to this operations.

getRevisionsWiringClosure

TabularData getRevisionsWiringClosure(long rootBundleId,
                                    String namespace)
                                      throws IOException,
                                             JMException

Returns the bundle wiring closure for all revisions of the specified bundle. The wiring closure contains all the wirings from the root bundle revision to all bundle revisions it is wired to and all their transitive wirings.

Parameters:

rootBundleId - The root bundle ID.

namespace - The namespace of the requirements and capabilities for which to return information.

Returns:

a tabular representation of all the wirings in the closure. The bundle revision IDs only have meaning in the context of the current result.

Throws:

JMException - if there is a JMX problem.

IOException - if the connection could not be made because of a communication problem.

See Also:

for the details of TabularData. The bundle wirings are in no particular order, and may change in subsequent calls to this operation. Furthermore, the bundle revision IDs are local and cannot be reused across invocations.