Package 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.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTRIBUTES
The key ofATTRIBUTES_ITEM
.static Item
ATTRIBUTES_ITEM
The item containing the attributes of a capability or requirement.static javax.management.openmbean.TabularType
ATTRIBUTES_TYPE
The Tabular Type that holds the attributes for a capability or requirements.static java.lang.String
BUNDLE_CAPABILITY
The key ofBUNDLE_CAPABILITY_ITEM
.static Item
BUNDLE_CAPABILITY_ITEM
The item containing a capability for a bundle inBUNDLE_WIRE_TYPE
.static javax.management.openmbean.CompositeType
BUNDLE_CAPABILITY_TYPE
The Composite Type that represents the capability of a bundle.static java.lang.String
BUNDLE_ID
The key ofBUNDLE_ID_ITEM
.static Item
BUNDLE_ID_ITEM
The item containing a bundle ID.static java.lang.String
BUNDLE_REQUIREMENT
The key ofBUNDLE_REQUIREMENT_ITEM
.static Item
BUNDLE_REQUIREMENT_ITEM
The item containing a requirement for a bundle inBUNDLE_WIRE_TYPE
.static javax.management.openmbean.CompositeType
BUNDLE_REQUIREMENT_TYPE
The Composite Type that represents the requirement of a bundle.static java.lang.String
BUNDLE_REVISION_ID
The key ofBUNDLE_REVISION_ID_ITEM
.static Item
BUNDLE_REVISION_ID_ITEM
The item containing a bundle revision ID.static javax.management.openmbean.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 javax.management.openmbean.ArrayType
BUNDLE_WIRES_TYPE_ARRAY
An array ofBUNDLE_WIRE_TYPE
s.static javax.management.openmbean.CompositeType
BUNDLE_WIRING_TYPE
The Composite Type that represents a bundle wiring.static javax.management.openmbean.TabularType
BUNDLES_WIRING_TYPE
The Tabular Type to hold the wiring of a number of bundles.static java.lang.String
CAPABILITIES
The key ofCAPABILITIES_ITEM
.static Item
CAPABILITIES_ITEM
The item containing the capabilities inREVISION_CAPABILITIES_TYPE
andBUNDLE_WIRING_TYPE
.static javax.management.openmbean.ArrayType
CAPABILITY_TYPE_ARRAY
An array ofBUNDLE_CAPABILITY_TYPE
s.static javax.management.openmbean.CompositeType
DIRECTIVE_TYPE
The Composite Type that represents a directive for a capability or requirement.static java.lang.String
DIRECTIVES
The key ofDIRECTIVES_ITEM
.static Item
DIRECTIVES_ITEM
The item containing the directives of a capability or requirement.static javax.management.openmbean.TabularType
DIRECTIVES_TYPE
The Tabular Type that holds the directives for a capability or requirement.static java.lang.String
KEY
The key ofKEY_ITEM
.static Item
KEY_ITEM
The item containing the key of a capability or requirement directive.static java.lang.String
NAMESPACE
The key ofNAMESPACE_ITEM
.static Item
NAMESPACE_ITEM
The item containing the namespace for a capability or requirement.static java.lang.String
OBJECTNAME
The Object Name prefix for this mbean.static java.lang.String
PROVIDED_WIRES
The key ofPROVIDED_WIRES_ITEM
.static Item
PROVIDED_WIRES_ITEM
The item containing the provided wires inBUNDLE_WIRING_TYPE
.static java.lang.String
PROVIDER_BUNDLE_ID
The key ofPROVIDER_BUNDLE_ID_ITEM
.static Item
PROVIDER_BUNDLE_ID_ITEM
The item containing the provider bundle ID inBUNDLE_WIRE_TYPE
.static java.lang.String
PROVIDER_BUNDLE_REVISION_ID
The key ofPROVIDER_BUNDLE_REVISION_ID_ITEM
.static Item
PROVIDER_BUNDLE_REVISION_ID_ITEM
The local ID of a provider revision inBUNDLE_WIRE_TYPE
.static java.lang.String
REQUIRED_WIRES
The key ofREQUIRED_WIRES_ITEM
.static Item
REQUIRED_WIRES_ITEM
The item containing the required wires inBUNDLE_WIRING_TYPE
.static javax.management.openmbean.ArrayType
REQUIREMENT_TYPE_ARRAY
An array ofBUNDLE_REQUIREMENT_TYPE
s.static java.lang.String
REQUIREMENTS
The key ofREQUIREMENTS_ITEM
.static Item
REQUIREMENTS_ITEM
The item containing the requirements inREVISION_REQUIREMENTS_TYPE
andBUNDLE_WIRING_TYPE
.static java.lang.String
REQUIRER_BUNDLE_ID
The key ofREQUIRER_BUNDLE_ID_ITEM
.static Item
REQUIRER_BUNDLE_ID_ITEM
The item containing the requirer bundle ID inBUNDLE_WIRE_TYPE
.static java.lang.String
REQUIRER_BUNDLE_REVISION_ID
The key ofREQUIRER_BUNDLE_REVISION_ID_ITEM
.static Item
REQUIRER_BUNDLE_REVISION_ID_ITEM
The local ID of a requirer revision inBUNDLE_WIRE_TYPE
.static javax.management.openmbean.CompositeType
REVISION_CAPABILITIES_TYPE
The Composite Type that represents the capabilities for a revision.static javax.management.openmbean.CompositeType
REVISION_REQUIREMENTS_TYPE
The Composite Type that represents the requirements of a revision.static javax.management.openmbean.TabularType
REVISIONS_CAPABILITIES_TYPE
The Tabular Type that holds the capabilities of a revision.static javax.management.openmbean.TabularType
REVISIONS_REQUIREMENTS_TYPE
The Tabular Type that hold the requirements of a revision.static java.lang.String
VALUE
The key ofVALUE
.static Item
VALUE_ITEM
The item containing the value of a capability or requirement directive.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.management.openmbean.CompositeData[]
getCurrentRevisionDeclaredCapabilities(long bundleId, java.lang.String namespace)
Returns the capabilities for the current bundle revision.javax.management.openmbean.CompositeData[]
getCurrentRevisionDeclaredRequirements(long bundleId, java.lang.String namespace)
Returns the requirements for the current bundle revision.javax.management.openmbean.CompositeData
getCurrentWiring(long bundleId, java.lang.String namespace)
Returns the bundle wiring for the current bundle revision.javax.management.openmbean.TabularData
getCurrentWiringClosure(long rootBundleId, java.lang.String namespace)
Returns the bundle wiring closure for the current revision of the specified bundle.javax.management.openmbean.TabularData
getRevisionsDeclaredCapabilities(long bundleId, java.lang.String namespace)
Returns the capabilities for all revisions of the bundle.javax.management.openmbean.TabularData
getRevisionsDeclaredRequirements(long bundleId, java.lang.String namespace)
Returns the requirements for all revisions of the bundle.javax.management.openmbean.TabularData
getRevisionsWiring(long bundleId, java.lang.String namespace)
Returns the bundle wirings for all revisions of the bundle.javax.management.openmbean.TabularData
getRevisionsWiringClosure(long rootBundleId, java.lang.String namespace)
Returns the bundle wiring closure for all revisions of the specified bundle.
-
-
-
Field Detail
-
OBJECTNAME
static final java.lang.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 java.lang.String KEY
The key ofKEY_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 inDIRECTIVE_TYPE
. The key isKEY
and the type is a String.
-
VALUE
static final java.lang.String VALUE
The key ofVALUE
.- See Also:
- Constant Field Values
-
VALUE_ITEM
static final Item VALUE_ITEM
The item containing the value of a capability or requirement directive. Used inDIRECTIVE_TYPE
. They key isVALUE
and the type is a String.
-
DIRECTIVE_TYPE
static final javax.management.openmbean.CompositeType DIRECTIVE_TYPE
-
DIRECTIVES_TYPE
static final javax.management.openmbean.TabularType DIRECTIVES_TYPE
The Tabular Type that holds the directives for a capability or requirement. The row type isDIRECTIVE_TYPE
and the index isKEY
.
-
DIRECTIVES
static final java.lang.String DIRECTIVES
The key ofDIRECTIVES_ITEM
.- See Also:
- Constant Field Values
-
DIRECTIVES_ITEM
static final Item DIRECTIVES_ITEM
The item containing the directives of a capability or requirement. Used inBUNDLE_REQUIREMENT_TYPE
andBUNDLE_CAPABILITY_TYPE
. The key isDIRECTIVES
and the type isDIRECTIVES_TYPE
.
-
ATTRIBUTES_TYPE
static final javax.management.openmbean.TabularType ATTRIBUTES_TYPE
The Tabular Type that holds the attributes for a capability or requirements. The row type isJmxConstants.PROPERTY_TYPE
and the index isJmxConstants.KEY
.
-
ATTRIBUTES
static final java.lang.String ATTRIBUTES
The key ofATTRIBUTES_ITEM
.- See Also:
- Constant Field Values
-
ATTRIBUTES_ITEM
static final Item ATTRIBUTES_ITEM
The item containing the attributes of a capability or requirement. Used inBUNDLE_REQUIREMENT_TYPE
andBUNDLE_CAPABILITY_TYPE
. The key isATTRIBUTES
and the type isATTRIBUTES_TYPE
.
-
NAMESPACE
static final java.lang.String NAMESPACE
The key ofNAMESPACE_ITEM
.- See Also:
- Constant Field Values
-
NAMESPACE_ITEM
static final Item NAMESPACE_ITEM
The item containing the namespace for a capability or requirement. Used inBUNDLE_REQUIREMENT_TYPE
andBUNDLE_CAPABILITY_TYPE
. The key isNAMESPACE
and the type is a String.
-
BUNDLE_REQUIREMENT_TYPE
static final javax.management.openmbean.CompositeType BUNDLE_REQUIREMENT_TYPE
The Composite Type that represents the requirement of a bundle. The composite consists of:
-
BUNDLE_CAPABILITY_TYPE
static final javax.management.openmbean.CompositeType BUNDLE_CAPABILITY_TYPE
The Composite Type that represents the capability of a bundle. The composite consists of:
-
PROVIDER_BUNDLE_ID
static final java.lang.String PROVIDER_BUNDLE_ID
The key ofPROVIDER_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 inBUNDLE_WIRE_TYPE
. The key isPROVIDER_BUNDLE_ID
and the type is a long.
-
REQUIRER_BUNDLE_ID
static final java.lang.String REQUIRER_BUNDLE_ID
The key ofREQUIRER_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 inBUNDLE_WIRE_TYPE
. The key isREQUIRER_BUNDLE_ID
and the type is long.
-
BUNDLE_REQUIREMENT
static final java.lang.String BUNDLE_REQUIREMENT
The key ofBUNDLE_REQUIREMENT_ITEM
.- See Also:
- Constant Field Values
-
BUNDLE_REQUIREMENT_ITEM
static final Item BUNDLE_REQUIREMENT_ITEM
The item containing a requirement for a bundle inBUNDLE_WIRE_TYPE
. The key isBUNDLE_REQUIREMENT
and the type isBUNDLE_REQUIREMENT_TYPE
.
-
BUNDLE_CAPABILITY
static final java.lang.String BUNDLE_CAPABILITY
The key ofBUNDLE_CAPABILITY_ITEM
.- See Also:
- Constant Field Values
-
BUNDLE_CAPABILITY_ITEM
static final Item BUNDLE_CAPABILITY_ITEM
The item containing a capability for a bundle inBUNDLE_WIRE_TYPE
. The key isBUNDLE_CAPABILITY
and the type isBUNDLE_CAPABILITY_TYPE
.
-
PROVIDER_BUNDLE_REVISION_ID
static final java.lang.String PROVIDER_BUNDLE_REVISION_ID
The key ofPROVIDER_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 inBUNDLE_WIRE_TYPE
. This ID is local to the result where it resides and has no defined meaning across multiple invocations. The key isPROVIDER_BUNDLE_REVISION_ID
and the type is an int.
-
REQUIRER_BUNDLE_REVISION_ID
static final java.lang.String REQUIRER_BUNDLE_REVISION_ID
The key ofREQUIRER_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 inBUNDLE_WIRE_TYPE
. This ID is local to the result where it resides and has no defined meaning across multiple invocations. The key isREQUIRER_BUNDLE_REVISION_ID
and the type is an int.
-
BUNDLE_WIRE_TYPE
static final javax.management.openmbean.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_WIRES_TYPE_ARRAY
static final javax.management.openmbean.ArrayType BUNDLE_WIRES_TYPE_ARRAY
An array ofBUNDLE_WIRE_TYPE
s.
-
BUNDLE_REVISION_ID
static final java.lang.String BUNDLE_REVISION_ID
The key ofBUNDLE_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 isBUNDLE_REVISION_ID
and the type is an integer.
-
BUNDLE_ID
static final java.lang.String BUNDLE_ID
The key ofBUNDLE_ID_ITEM
.- See Also:
- Constant Field Values
-
BUNDLE_ID_ITEM
static final Item BUNDLE_ID_ITEM
The item containing a bundle ID. They key isBUNDLE_ID
and the type is a long.
-
REQUIREMENT_TYPE_ARRAY
static final javax.management.openmbean.ArrayType REQUIREMENT_TYPE_ARRAY
An array ofBUNDLE_REQUIREMENT_TYPE
s.
-
CAPABILITY_TYPE_ARRAY
static final javax.management.openmbean.ArrayType CAPABILITY_TYPE_ARRAY
An array ofBUNDLE_CAPABILITY_TYPE
s.
-
REQUIREMENTS
static final java.lang.String REQUIREMENTS
The key ofREQUIREMENTS_ITEM
.- See Also:
- Constant Field Values
-
REQUIREMENTS_ITEM
static final Item REQUIREMENTS_ITEM
The item containing the requirements inREVISION_REQUIREMENTS_TYPE
andBUNDLE_WIRING_TYPE
. The key isREQUIREMENTS
and the type isREQUIREMENT_TYPE_ARRAY
.
-
REVISION_REQUIREMENTS_TYPE
static final javax.management.openmbean.CompositeType REVISION_REQUIREMENTS_TYPE
The Composite Type that represents the requirements of a revision. The composite consists of:
-
REVISIONS_REQUIREMENTS_TYPE
static final javax.management.openmbean.TabularType REVISIONS_REQUIREMENTS_TYPE
The Tabular Type that hold the requirements of a revision. The row type isREVISION_REQUIREMENTS_TYPE
and the index isBUNDLE_REVISION_ID
.
-
CAPABILITIES
static final java.lang.String CAPABILITIES
The key ofCAPABILITIES_ITEM
.- See Also:
- Constant Field Values
-
CAPABILITIES_ITEM
static final Item CAPABILITIES_ITEM
The item containing the capabilities inREVISION_CAPABILITIES_TYPE
andBUNDLE_WIRING_TYPE
. The key isCAPABILITIES
and the type isCAPABILITY_TYPE_ARRAY
.
-
REVISION_CAPABILITIES_TYPE
static final javax.management.openmbean.CompositeType REVISION_CAPABILITIES_TYPE
The Composite Type that represents the capabilities for a revision. The composite consists of:
-
REVISIONS_CAPABILITIES_TYPE
static final javax.management.openmbean.TabularType REVISIONS_CAPABILITIES_TYPE
The Tabular Type that holds the capabilities of a revision. The row type isREVISION_CAPABILITIES_TYPE
and the index isBUNDLE_REVISION_ID
.
-
PROVIDED_WIRES
static final java.lang.String PROVIDED_WIRES
The key ofPROVIDED_WIRES_ITEM
.- See Also:
- Constant Field Values
-
PROVIDED_WIRES_ITEM
static final Item PROVIDED_WIRES_ITEM
The item containing the provided wires inBUNDLE_WIRING_TYPE
. The key isPROVIDED_WIRES
and the type isBUNDLE_WIRES_TYPE_ARRAY
.
-
REQUIRED_WIRES
static final java.lang.String REQUIRED_WIRES
The key ofREQUIRED_WIRES_ITEM
.- See Also:
- Constant Field Values
-
REQUIRED_WIRES_ITEM
static final Item REQUIRED_WIRES_ITEM
The item containing the required wires inBUNDLE_WIRING_TYPE
. The key isREQUIRED_WIRES
and the type isBUNDLE_WIRES_TYPE_ARRAY
.
-
BUNDLE_WIRING_TYPE
static final javax.management.openmbean.CompositeType BUNDLE_WIRING_TYPE
The Composite Type that represents a bundle wiring. The composite consists of:
-
BUNDLES_WIRING_TYPE
static final javax.management.openmbean.TabularType BUNDLES_WIRING_TYPE
The Tabular Type to hold the wiring of a number of bundles. The row type isBUNDLE_WIRING_TYPE
and the index is the combination of theBUNDLE_ID
and theBUNDLE_REVISION_ID
.
-
-
Method Detail
-
getCurrentRevisionDeclaredRequirements
javax.management.openmbean.CompositeData[] getCurrentRevisionDeclaredRequirements(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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
andnamespace
. - Throws:
javax.management.JMException
- if there is a JMX problem.java.io.IOException
- if the connection could not be made because of a communication problem.- See Also:
for the details of the CompositeData.
-
getCurrentRevisionDeclaredCapabilities
javax.management.openmbean.CompositeData[] getCurrentRevisionDeclaredCapabilities(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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
andnamespace
. - Throws:
javax.management.JMException
- if there is a JMX problem.java.io.IOException
- if the connection could not be made because of a communication problem.- See Also:
for the details of the CompositeData.
-
getCurrentWiring
javax.management.openmbean.CompositeData getCurrentWiring(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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
andnamespace
. - Throws:
javax.management.JMException
- if there is a JMX problem.java.io.IOException
- if the connection could not be made because of a communication problem.- See Also:
for the details of the CompositeData.
-
getCurrentWiringClosure
javax.management.openmbean.TabularData getCurrentWiringClosure(long rootBundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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:
javax.management.JMException
- if there is a JMX problem.java.io.IOException
- if the connection could not be made because of a communication problem.- See Also:
for the details of the TabularData.
-
getRevisionsDeclaredRequirements
javax.management.openmbean.TabularData getRevisionsDeclaredRequirements(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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:
javax.management.JMException
- if there is a JMX problem.java.io.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
javax.management.openmbean.TabularData getRevisionsDeclaredCapabilities(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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:
javax.management.JMException
- if there is a JMX problem.java.io.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
javax.management.openmbean.TabularData getRevisionsWiring(long bundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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
andnamespace
. - Throws:
javax.management.JMException
- if there is a JMX problem.java.io.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
javax.management.openmbean.TabularData getRevisionsWiringClosure(long rootBundleId, java.lang.String namespace) throws java.io.IOException, javax.management.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:
javax.management.JMException
- if there is a JMX problem.java.io.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.
-
-