Bundle

std::ostream &cppmicroservices::operator<<(std::ostream &os, const Bundle &bundle)

Streams a textual representation of bundle into the stream os.

std::ostream &cppmicroservices::operator<<(std::ostream &os, Bundle const *bundle)

This is the same as calling os << *bundle.

std::ostream &cppmicroservices::operator<<(std::ostream &os, Bundle::State state)

Streams a textual representation of the bundle state enumeration.

class cppmicroservices::Bundle
#include <cppmicroservices/Bundle.h>

An installed bundle in the Framework.

A Bundle object is the access point to define the lifecycle of an installed bundle. Each bundle installed in the CppMicroServices environment has an associated Bundle object.

A bundle has a unique identity, a long, chosen by the Framework. This identity does not change during the lifecycle of a bundle. Uninstalling and then reinstalling the bundle creates a new unique identity.

A bundle can be in one of six states:

  • STATE_UNINSTALLED
  • STATE_INSTALLED
  • STATE_RESOLVED
  • STATE_STARTING
  • STATE_STOPPING
  • STATE_ACTIVE

Values assigned to these states have no specified ordering; they represent bit values that may be ORed together to determine if a bundle is in one of the valid states.

A bundle should only have active threads of execution when its state is one of STATE_STARTING,STATE_ACTIVE, or STATE_STOPPING. A STATE_UNINSTALLED bundle can not be set to another state; it is a zombie and can only be reached because references are kept somewhere.

The framework is the only entity that is allowed to create Bundle objects, and these objects are only valid within the Framework that created them.

Bundles have a natural ordering such that if two Bundles have the same bundle id they are equal. A Bundle is less than another Bundle if it has a lower bundle id and is greater if it has a higher bundle id.

Remark
This class is thread safe.

Subclassed by cppmicroservices::Framework

Public Types

enum State

The bundle state.

Values:

STATE_UNINSTALLED = 0x00000001

The bundle is uninstalled and may not be used.

The STATE_UNINSTALLED state is only visible after a bundle is uninstalled; the bundle is in an unusable state but references to the Bundle object may still be available and used for introspection.

The value of STATE_UNINSTALLED is 0x00000001.

STATE_INSTALLED = 0x00000002

The bundle is installed but not yet resolved.

A bundle is in the STATE_INSTALLED state when it has been installed in the Framework but is not or cannot be resolved.

This state is visible if the bundle’s code dependencies are not resolved. The Framework may attempt to resolve a STATE_INSTALLED bundle’s code dependencies and move the bundle to the STATE_RESOLVED state.

The value of STATE_INSTALLED is 0x00000002.

STATE_RESOLVED = 0x00000004

The bundle is resolved and is able to be started.

A bundle is in the STATE_RESOLVED state when the Framework has successfully resolved the bundle’s code dependencies. These dependencies include:

  • None (this may change in future versions)

Note that the bundle is not active yet. A bundle is put in the STATE_RESOLVED state before it can be started. The Framework may attempt to resolve a bundle at any time.

The value of STATE_RESOLVED is 0x00000004.

STATE_STARTING = 0x00000008

The bundle is in the process of starting.

A bundle is in the STATE_STARTING state when its Start method is active. A bundle must be in this state when the bundle’s BundleActivator::Start(BundleContext) is called. If the BundleActivator::Start method completes without exception, then the bundle has successfully started and moves to the STATE_ACTIVE state.

If the bundle has a lazy activation policy, then the bundle may remain in this state for some time until the activation is triggered.

The value of STATE_STARTING is 0x00000008.

STATE_STOPPING = 0x00000010

The bundle is in the process of stopping.

A bundle is in the STATE_STOPPING state when its Stop method is active. A bundle is in this state when the bundle’s BundleActivator#Stop(BundleContext) method is called. When the BundleActivator::Stop method completes the bundle is stopped and moves to the STATE_RESOLVED state.

The value of STATE_STOPPING is 0x00000010.

STATE_ACTIVE = 0x00000020

The bundle is now running.

A bundle is in the STATE_ACTIVE state when it has been successfully started and activated.

The value of STATE_ACTIVE is 0x00000020.

enum StartOptions

Values:

START_TRANSIENT = 0x00000001

The bundle start operation is transient and the persistent autostart setting of the bundle is not modified.

This bit may be set when calling Start(uint32_t) to notify the framework that the autostart setting of the bundle must not be modified. If this bit is not set, then the autostart setting of the bundle is modified.

See
Start(uint32_t)
Note
This option is reserved for future use and not supported yet.

START_ACTIVATION_POLICY = 0x00000002

The bundle start operation must activate the bundle according to the bundle’s declared activation policy.

This bit may be set when calling Start(uint32_t) to notify the framework that the bundle must be activated using the bundle’s declared activation policy.

See
Constants::BUNDLE_ACTIVATIONPOLICY
See
Start(uint32_t)
Note
This option is reserved for future use and not supported yet.

enum StopOptions

Values:

STOP_TRANSIENT = 0x00000001

The bundle stop is transient and the persistent autostart setting of the bundle is not modified.

This bit may be set when calling Stop(uint32_t) to notify the framework that the autostart setting of the bundle must not be modified. If this bit is not set, then the autostart setting of the bundle is modified.

See
Stop(uint32_t)
Note
This option is reserved for future use and not supported yet.

typedef detail::Clock::time_point TimeStamp

Public Functions

Bundle(const Bundle&)
Bundle(Bundle&&)
Bundle &operator=(const Bundle&)
Bundle &operator=(Bundle&&)
Bundle()

Constructs an invalid Bundle object.

Valid bundle objects can only be created by the framework in response to certain calls to a BundleContext object. A BundleContext object is supplied to a bundle via its BundleActivator or as a return value of the GetBundleContext() method.

See
operator bool() const

virtual ~Bundle()
bool operator==(const Bundle &rhs) const

Compares this Bundle object with the specified bundle.

Valid Bundle objects compare equal if and only if they are installed in the same framework instance and their bundle id is equal. Invalid Bundle objects are always considered to be equal.

Return
true if this Bundle object is equal to rhs, false otherwise.
Parameters
  • rhs: The Bundle object to compare this object with.

bool operator!=(const Bundle &rhs) const

Compares this Bundle object with the specified bundle for inequality.

Return
Returns the result of !(*this == rhs).
Parameters
  • rhs: The Bundle object to compare this object with.

bool operator<(const Bundle &rhs) const

Compares this Bundle with the specified bundle for order.

Bundle objects are ordered first by their framework id and then according to their bundle id. Invalid Bundle objects will always compare greater then valid Bundle objects.

Return
Parameters
  • rhs: The Bundle object to compare this object with.

operator bool() const

Tests this Bundle object for validity.

Invalid Bundle objects are created by the default constructor or can be returned by certain framework methods if the bundle has been uninstalled.

Return
true if this Bundle object is valid and can safely be used, false otherwise.

Bundle &operator=(std::nullptr_t)

Releases any resources held or locked by this Bundle and renders it invalid.

State GetState() const

Returns this bundle’s current state.

A bundle can be in only one state at any time.

Return
An element of STATE_UNINSTALLED,STATE_INSTALLED, STATE_RESOLVED, STATE_STARTING, STATE_STOPPING, STATE_ACTIVE.

BundleContext GetBundleContext() const

Returns this bundle’s BundleContext.

The returned BundleContext can be used by the caller to act on behalf of this bundle.

If this bundle is not in the STATE_STARTED state, then this bundle has no valid BundleContext and this method will return a default constructed BundleContext object.

Return
A valid or invalid BundleContext for this bundle or.

long GetBundleId() const

Returns this bundle’s unique identifier.

This bundle is assigned a unique identifier by the framework when it was installed.

A bundle’s unique identifier has the following attributes:

  • Is unique.
  • Is a long.
  • Its value is not reused for another bundle, even after a bundle is uninstalled.
  • Does not change while a bundle remains installed.
  • Does not change when a bundle is re-started.

This method continues to return this bundle’s unique identifier while this bundle is in the STATE_UNINSTALLED state.

Return
The unique identifier of this bundle.

std::string GetLocation() const

Returns this bundle’s location.

The location is the full path to the bundle’s shared library. This method continues to return this bundle’s location while this bundle is in the STATE_UNINSTALLED state.

Return
The string representation of this bundle’s location.

std::string GetSymbolicName() const

Returns the symbolic name of this bundle as specified by the US_BUNDLE_NAME preprocessor definition.

The bundle symbolic name together with a version must identify a unique bundle.

This method continues to return this bundle’s symbolic name while this bundle is in the STATE_UNINSTALLED state.

Return
The symbolic name of this bundle.

BundleVersion GetVersion() const

Returns the version of this bundle as specified in its manifest.json file.

If this bundle does not have a specified version then BundleVersion::EmptyVersion is returned.

This method continues to return this bundle’s version while this bundle is in the STATE_UNINSTALLED state.

Return
The version of this bundle.

std::map<std::string, Any> GetProperties() const

Returns this bundle’s Manifest properties as key/value pairs.

Return
A map containing this bundle’s Manifest properties as key/value pairs.

AnyMap GetHeaders() const

Returns this bundle’s Manifest headers and values.

Manifest header names are case-insensitive. The methods of the returned AnyMap object operate on header names in a case-insensitive manner.

If a Manifest header value starts with “%”, it is localized according to the default locale. If no localization is found for a header value, the header value without the leading “%” is returned.

This method continues to return Manifest header information while this bundle is in the UNINSTALLED state.

Note
Localization is not yet supported, hence the leading “%” is always removed.

Return
A map containing this bundle’s Manifest headers and values.
See
Constants::BUNDLE_LOCALIZATION

Any GetProperty(const std::string &key) const

Returns the value of the specified property for this bundle.

If not found, the framework’s properties are searched. The method returns an empty Any if the property is not found.

Deprecated since version 3.0: Use GetHeaders() or BundleContext::GetProperty(const std::string&) instead.

Return
The value of the requested property, or an empty string if the property is undefined.
Parameters
  • key: The name of the requested property.

std::vector<std::string> GetPropertyKeys() const

Returns a list of top-level property keys for this bundle.

Return
A list of available property keys.

std::vector<ServiceReferenceU> GetRegisteredServices() const

Returns this bundle’s ServiceReference list for all services it has registered or an empty list if this bundle has no registered services.

The list is valid at the time of the call to this method, however, as the framework is a very dynamic environment, services can be modified or unregistered at anytime.

Return
A list of ServiceReference objects for services this bundle has registered.
Exceptions
  • std::logic_error: If this bundle has been uninstalled, if the ServiceRegistrationBase object is invalid, or if the service is unregistered.

std::vector<ServiceReferenceU> GetServicesInUse() const

Returns this bundle’s ServiceReference list for all services it is using or returns an empty list if this bundle is not using any services.

A bundle is considered to be using a service if its use count for that service is greater than zero.

The list is valid at the time of the call to this method, however, as the framework is a very dynamic environment, services can be modified or unregistered at anytime.

Return
A list of ServiceReference objects for all services this bundle is using.
Exceptions
  • std::logic_error: If this bundle has been uninstalled, if the ServiceRegistrationBase object is invalid, or if the service is unregistered.

BundleResource GetResource(const std::string &path) const

Returns the resource at the specified path in this bundle.

The specified path is always relative to the root of this bundle and may begin with ‘/’. A path value of “/” indicates the root of this bundle.

Return
A BundleResource object for the given path. If the path cannot be found in this bundle an invalid BundleResource object is returned.
Parameters
  • path: The path name of the resource.
Exceptions
  • std::logic_error: If this bundle has been uninstalled.

std::vector<BundleResource> FindResources(const std::string &path, const std::string &filePattern, bool recurse) const

Returns resources in this bundle.

This method is intended to be used to obtain configuration, setup, localization and other information from this bundle.

This method can either return only resources in the specified path or recurse into subdirectories returning resources in the directory tree beginning at the specified path.

Examples:

  auto bundleContext = GetBundleContext();
  auto bundle = bundleContext.GetBundle();

  // List all XML files in the config directory
  std::vector<BundleResource> xmlFiles = bundle.FindResources("config", "*.xml", false);

  // Find the resource named vertex_shader.txt starting at the root directory
  std::vector<BundleResource> shaders = bundle.FindResources("", "vertex_shader.txt", true);
Return
A vector of BundleResource objects for each matching entry.
Parameters
  • path: The path name in which to look. The path is always relative to the root of this bundle and may begin with ‘/’. A path value of “/” indicates the root of this bundle.
  • filePattern: The resource name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the resource path. Substring matching is supported using the wildcard charachter (‘*’). If filePattern is empty, this is equivalent to “*” and matches all resources.
  • recurse: If true, recurse into subdirectories. Otherwise only return resources from the specified path.
Exceptions
  • std::logic_error: If this bundle has been uninstalled.

TimeStamp GetLastModified() const

Returns the time when this bundle was last modified.

A bundle is considered to be modified when it is installed, updated or uninstalled.

Return
The time when this bundle was last modified.

void Start(uint32_t options)

Starts this bundle.

If this bundle’s state is STATE_UNINSTALLED then a std::logic_error is thrown.

The Framework sets this bundle’s persistent autostart setting to Started with declared activation if the START_ACTIVATION_POLICY option is set or Started with eager activation if not set.

The following steps are executed to start this bundle:

  1. If this bundle is in the process of being activated or deactivated, then this method waits for activation or deactivation to complete before continuing. If this does not occur in a reasonable time, a std::runtime_error is thrown to indicate this bundle was unable to be started.
  2. If this bundle’s state is STATE_ACTIVE, then this method returns immediately.
  3. If the START_TRANSIENT option is not set, then set this bundle’s autostart setting to Started with declared activation if the START_ACTIVATION_POLICY option is set or Started with eager activation if not set. When the Framework is restarted and this bundle’s autostart setting is not Stopped, this bundle must be automatically started.
  4. If this bundle’s state is not STATE_RESOLVED, an attempt is made to resolve this bundle. If the Framework cannot resolve this bundle, a std::runtime_error is thrown.
  5. If the START_ACTIVATION_POLICY option is set and this bundle’s declared activation policy is lazy then:
    • If this bundle’s state is STATE_STARTING, then this method returns immediately.
    • This bundle’s state is set to STATE_STARTING.
    • A bundle event of type BundleEvent#BUNDLE_LAZY_ACTIVATION is fired.
    • This method returns immediately and the remaining steps will be followed when this bundle’s activation is later triggered.
  6. This bundle’s state is set to STATE_STARTING.
  7. A bundle event of type BundleEvent#BUNDLE_STARTING is fired.
  8. If the bundle is contained in a shared library, the library is loaded and the BundleActivator#Start(BundleContext) method of this bundle’s BundleActivator (if one is specified) is called. If the shared library could not be loaded, or the BundleActivator is invalid or throws an exception then:
    • This bundle’s state is set to STATE_STOPPING.
    • A bundle event of type BundleEvent#BUNDLE_STOPPING is fired.
    • Any services registered by this bundle are unregistered.
    • Any services used by this bundle are released.
    • Any listeners registered by this bundle are removed.
    • This bundle’s state is set to STATE_RESOLVED.
    • A bundle event of type BundleEvent#BUNDLE_STOPPED is fired.
    • A std::runtime_error exception is then thrown.
  9. If this bundle’s state is STATE_UNINSTALLED, because this bundle was uninstalled while the BundleActivator::Start method was running, a std::logic_error is thrown.
  10. This bundle’s state is set to STATE_ACTIVE.
  11. A bundle event of type BundleEvent#BUNDLE_STARTED is fired.

Preconditions

  1. GetState() in { STATE_INSTALLED, STATE_RESOLVED } or { STATE_INSTALLED, STATE_RESOLVED, STATE_STARTING } if this bundle has a lazy activation policy.

Postconditions, no exceptions thrown

  1. Bundle autostart setting is modified unless the START_TRANSIENT option was set.
  2. GetState() in { STATE_ACTIVE } unless the lazy activation policy was used.
  3. BundleActivator::Start() has been called and did not throw an exception unless the lazy activation policy was used.

Postconditions, when an exception is thrown

  1. Depending on when the exception occurred, the bundle autostart setting is modified unless the START_TRANSIENT option was set.
  2. GetState() not in { STATE_STARTING, STATE_ACTIVE }.

Parameters
Exceptions
  • std::runtime_error: If this bundle could not be started.
  • std::logic_error: If this bundle has been uninstalled or this bundle tries to change its own state.

void Start()

Starts this bundle with no options.

This method performs the same function as calling Start(0).

See
Start(uint32_t)
Exceptions
  • std::runtime_error: If this bundle could not be started.
  • std::logic_error: If this bundle has been uninstalled or this bundle tries to change its own state.

void Stop(uint32_t options)

Stops this bundle.

The following steps are executed when stopping a bundle:

  1. If this bundle’s state is STATE_UNINSTALLED then a std::logic_error is thrown.
  2. If this bundle is in the process of being activated or deactivated then this method waits for activation or deactivation to complete before continuing. If this does not occur in a reasonable time, a std::runtime_error is thrown to indicate this bundle was unable to be stopped.
  3. If the STOP_TRANSIENT option is not set then set this bundle’s persistent autostart setting to Stopped. When the Framework is restarted and this bundle’s autostart setting is Stopped, this bundle will not be automatically started.
  4. If this bundle’s state is not STATE_STARTING or STATE_ACTIVE then this method returns immediately.
  5. This bundle’s state is set to STATE_STOPPING.
  6. A bundle event of type BundleEvent#BUNDLE_STOPPING is fired.
  7. If this bundle’s state was STATE_ACTIVE prior to setting the state to STATE_STOPPING, the BundleActivator#Stop(BundleContext) method of this bundle’s BundleActivator, if one is specified, is called. If that method throws an exception, this method continues to stop this bundle and a std::runtime_error is thrown after completion of the remaining steps.
  8. Any services registered by this bundle are unregistered.
  9. Any services used by this bundle are released.
  10. Any listeners registered by this bundle are removed.
  11. If this bundle’s state is STATE_UNINSTALLED, because this bundle was uninstalled while the BundleActivator::Stop method was running, a std::runtime_error is thrown.
  12. This bundle’s state is set to STATE_RESOLVED.
  13. A bundle event of type BundleEvent#BUNDLE_STOPPED is fired.

Preconditions

  1. GetState() in { STATE_ACTIVE }.

Postconditions, no exceptions thrown

  1. Bundle autostart setting is modified unless the STOP_TRANSIENT option was set.
  2. GetState() not in { STATE_ACTIVE, STATE_STOPPING }.
  3. BundleActivator::Stop has been called and did not throw an exception.

Postconditions, when an exception is thrown

  1. Bundle autostart setting is modified unless the STOP_TRANSIENT option was set.

Parameters
Exceptions
  • std::runtime_error: If the bundle failed to stop.
  • std::logic_error: If this bundle has been uninstalled or this bundle tries to change its own state.

void Stop()

Stops this bundle with no options.

This method performs the same function as calling Stop(0).

See
Stop(uint32_t)
Exceptions
  • std::runtime_error: If the bundle failed to stop.
  • std::logic_error: If this bundle has been uninstalled or this bundle tries to change its own state.

void Uninstall()

Uninstalls this bundle.

This method causes the Framework to notify other bundles that this bundle is being uninstalled, and then puts this bundle into the STATE_UNINSTALLED state. The Framework removes any resources related to this bundle that it is able to remove.

The following steps are executed to uninstall a bundle:

  1. If this bundle’s state is STATE_UNINSTALLED, then a std::logic_error is thrown.
  2. If this bundle’s state is STATE_ACTIVE, STATE_STARTING or STATE_STOPPING, this bundle is stopped as described in the Bundle::Stop method. If Bundle::Stop throws an exception, a Framework event of type FrameworkEvent#FRAMEWORK_ERROR is fired containing the exception.
  3. This bundle’s state is set to STATE_UNINSTALLED.
  4. A bundle event of type BundleEvent#BUNDLE_UNINSTALLED is fired.
  5. This bundle and any persistent storage area provided for this bundle by the Framework are removed.

Preconditions

Postconditions, no exceptions thrown

  • GetState() in { STATE_UNINSTALLED }.
  • This bundle has been uninstalled.

Postconditions, when an exception is thrown

  • GetState() not in { STATE_UNINSTALLED }.
  • This Bundle has not been uninstalled.

See
Stop()
Exceptions
  • std::runtime_error: If the uninstall failed. This can occur if another thread is attempting to change this bundle’s state and does not complete in a timely manner, or if the bundle is embedded in an executable.
  • std::logic_error: If this bundle has been uninstalled or this bundle tries to change its own state.

Protected Functions

Bundle(const std::shared_ptr<BundlePrivate> &d)

Protected Attributes

std::shared_ptr<BundlePrivate> d
std::shared_ptr<CoreBundleContext> c

Friends

friend gr_bundle::BundleRegistry
Bundle MakeBundle(const std::shared_ptr<BundlePrivate>&)