org.apache.aries.jmx.framework.wiring

Class BundleWiringState

java.lang.Object

org.apache.aries.jmx.framework.wiring.BundleWiringState

All Implemented Interfaces:

BundleWiringStateMBean

public class BundleWiringState
extends Object
implements BundleWiringStateMBean

Field Summary

Fields inherited from interface org.osgi.jmx.framework.wiring.BundleWiringStateMBean

ATTRIBUTES, ATTRIBUTES_ITEM, ATTRIBUTES_TYPE, BUNDLE_CAPABILITY, BUNDLE_CAPABILITY_ITEM, BUNDLE_CAPABILITY_TYPE, BUNDLE_ID, BUNDLE_ID_ITEM, BUNDLE_REQUIREMENT, BUNDLE_REQUIREMENT_ITEM, BUNDLE_REQUIREMENT_TYPE, BUNDLE_REVISION_ID, BUNDLE_REVISION_ID_ITEM, BUNDLE_WIRE_TYPE, BUNDLE_WIRES_TYPE_ARRAY, BUNDLE_WIRING_TYPE, BUNDLES_WIRING_TYPE, CAPABILITIES, CAPABILITIES_ITEM, CAPABILITY_TYPE_ARRAY, DIRECTIVE_TYPE, DIRECTIVES, DIRECTIVES_ITEM, DIRECTIVES_TYPE, KEY, KEY_ITEM, NAMESPACE, NAMESPACE_ITEM, OBJECTNAME, PROVIDED_WIRES, PROVIDED_WIRES_ITEM, PROVIDER_BUNDLE_ID, PROVIDER_BUNDLE_ID_ITEM, PROVIDER_BUNDLE_REVISION_ID, PROVIDER_BUNDLE_REVISION_ID_ITEM, REQUIRED_WIRES, REQUIRED_WIRES_ITEM, REQUIREMENT_TYPE_ARRAY, REQUIREMENTS, REQUIREMENTS_ITEM, REQUIRER_BUNDLE_ID, REQUIRER_BUNDLE_ID_ITEM, REQUIRER_BUNDLE_REVISION_ID, REQUIRER_BUNDLE_REVISION_ID_ITEM, REVISION_CAPABILITIES_TYPE, REVISION_REQUIREMENTS_TYPE, REVISIONS_CAPABILITIES_TYPE, REVISIONS_REQUIREMENTS_TYPE, VALUE, VALUE_ITEM

Constructor Summary

Constructors

Constructor and Description
BundleWiringState(org.osgi.framework.BundleContext bundleContext, Logger logger)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BundleWiringState

public BundleWiringState(org.osgi.framework.BundleContext bundleContext,
                 Logger logger)

Method Detail

getCurrentRevisionDeclaredRequirements

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

Description copied from interface: BundleWiringStateMBean

Returns the requirements for the current bundle revision.

Specified by:

getCurrentRevisionDeclaredRequirements in interface BundleWiringStateMBean

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:

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

See Also:

for the details of the CompositeData.

getCurrentRevisionDeclaredCapabilities

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

Description copied from interface: BundleWiringStateMBean

Returns the capabilities for the current bundle revision.

Specified by:

getCurrentRevisionDeclaredCapabilities in interface BundleWiringStateMBean

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:

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

See Also:

for the details of the CompositeData.

getCurrentWiring

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

Description copied from interface: BundleWiringStateMBean

Returns the bundle wiring for the current bundle revision.

Specified by:

getCurrentWiring in interface BundleWiringStateMBean

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:

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

See Also:

for the details of the CompositeData.

getCurrentWiringClosure

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

Description copied from interface: BundleWiringStateMBean

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.

Specified by:

getCurrentWiringClosure in interface BundleWiringStateMBean

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:

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

See Also:

for the details of the TabularData.

getRevisionsDeclaredRequirements

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

Description copied from interface: BundleWiringStateMBean

Returns the requirements for all revisions of the bundle.

Specified by:

getRevisionsDeclaredRequirements in interface BundleWiringStateMBean

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:

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

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

Description copied from interface: BundleWiringStateMBean

Returns the capabilities for all revisions of the bundle.

Specified by:

getRevisionsDeclaredCapabilities in interface BundleWiringStateMBean

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:

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

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

Description copied from interface: BundleWiringStateMBean

Returns the bundle wirings for all revisions of the bundle.

Specified by:

getRevisionsWiring in interface BundleWiringStateMBean

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:

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

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

Description copied from interface: BundleWiringStateMBean

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.

Specified by:

getRevisionsWiringClosure in interface BundleWiringStateMBean

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:

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.