Poco::OSP

class BundleManifest

Library: OSP
Package: Bundle
Header: Poco/OSP/BundleManifest.h

Description

The BundleManifest class parses and stores the manifest of a bundle.

Inheritance

Direct Base Classes: Poco::RefCountedObject

All Base Classes: Poco::RefCountedObject

Member Summary

Member Functions: activatorClass, activatorLibrary, copyright, extendedBundle, lazyStart, name, parseActivator, parseManifest, parseProvidedModules, parseRequiredBundles, parseRequiredItems, parseRequiredModules, preventUninstall, providedModules, rawManifest, requiredBundles, requiredModules, runLevel, sealed, symbolicName, vendor, version

Inherited Functions: duplicate, referenceCount, release

Nested Classes

struct Dependency

 more...

struct Module

 more...

Types

ConstPtr

typedef const Ptr ConstPtr;

Dependencies

typedef std::vector < Dependency > Dependencies;

Modules

typedef std::vector < Module > Modules;

Ptr

typedef Poco::AutoPtr < BundleManifest > Ptr;

Constructors

BundleManifest

BundleManifest(
    std::istream & istr
);

Creates the BundleManifest by parsing the META-INF/manifest.mf file.

Destructor

~BundleManifest protected virtual

~BundleManifest();

Destroys the BundleManifest.

Member Functions

activatorClass inline

const std::string & activatorClass() const;

Returns the class name of the bundle's activator, or an empty string if the manifest does not specify an activator.

activatorLibrary inline

const std::string & activatorLibrary() const;

Returns the name of the library containing the bundle's activator class, or an empty string if the manifest does not specify an activator library.

copyright inline

const std::string & copyright() const;

Returns the bundle's copyright information, or an empty string if no copyright information has been specified in the pManifest->

extendedBundle inline

const std::string & extendedBundle() const;

Returns the name of the bundle this bundle extends, or an empty string if the bundle is not an extension bundle.

lazyStart inline

bool lazyStart() const;

Returns true if lazy startup has been specified for the bundle.

name inline

const std::string & name() const;

Returns the name of the bundle.

preventUninstall inline

bool preventUninstall() const;

Returns true if the bundle must not be uninstalled at run-time.

This is mostly useful for bundles that cannot be cleanly stopped. An example are bundles that contain third-party libraries that, once loaded, cannot be unloaded cleanly.

providedModules inline

const Modules & providedModules() const;

Returns a vector containing information about all modules provided by this bundle.

rawManifest

Poco::Util::AbstractConfiguration & rawManifest() const;

Returns a reference to the configuration containing the raw manifest data.

requiredBundles inline

const Dependencies & requiredBundles() const;

Returns a vector containing information about all bundles required by this bundle.

requiredModules inline

const Dependencies & requiredModules() const;

Returns a vector containing information about all modules required by this bundle.

runLevel inline

const std::string & runLevel() const;

Returns the bundle's run level.

If the bundle does not specify a run level, returns the default "999-user".

sealed inline

bool sealed() const;

Returns true if the bundle is sealed and cannot be extended by an extension bundle.

symbolicName inline

const std::string & symbolicName() const;

Returns the symbolic name of the bundle.

vendor inline

const std::string & vendor() const;

Returns the bundle's vendor name, or an empty string if no vendor name has been specified in the pManifest->

version inline

const Version & version() const;

Returns the version of the bundle.

parseActivator protected

void parseActivator(
    const std::string & activator
);

Parses the Bundle-Activator property.

parseManifest protected

void parseManifest();

Parses the bundle's manifest file.

parseProvidedModules protected

void parseProvidedModules(
    const std::string & providedModules
);

Parses the Provided-Modules property.

parseRequiredBundles protected

void parseRequiredBundles(
    const std::string & requiredBundles
);

Parses the Required-Bundles property.

parseRequiredItems protected

void parseRequiredItems(
    const std::string & requiredItems,
    const std::string & what,
    const std::string & versionKeyword,
    Dependencies & dependencies
);

Parses the Required-Bundles or Required-Modules property and stored result in dependencies.

parseRequiredModules protected

void parseRequiredModules(
    const std::string & requiredModules
);

Parses the Required-Modules property.

Variables

BUNDLE_ACTIVATOR static

static const std::string BUNDLE_ACTIVATOR;

BUNDLE_CERTIFICATE static

static const std::string BUNDLE_CERTIFICATE;

BUNDLE_COPYRIGHT static

static const std::string BUNDLE_COPYRIGHT;

BUNDLE_LAZYSTART static

static const std::string BUNDLE_LAZYSTART;

BUNDLE_NAME static

static const std::string BUNDLE_NAME;

BUNDLE_PREVENTUNINSTALL static

static const std::string BUNDLE_PREVENTUNINSTALL;

BUNDLE_RUNLEVEL static

static const std::string BUNDLE_RUNLEVEL;

BUNDLE_SEALED static

static const std::string BUNDLE_SEALED;

BUNDLE_SYMBOLICNAME static

static const std::string BUNDLE_SYMBOLICNAME;

BUNDLE_VENDOR static

static const std::string BUNDLE_VENDOR;

BUNDLE_VERSION static

static const std::string BUNDLE_VERSION;

DEFAULT_RUNLEVEL static

static const std::string DEFAULT_RUNLEVEL;

EXTENDS_BUNDLE static

static const std::string EXTENDS_BUNDLE;

MANIFEST_VERSION static

static const std::string MANIFEST_VERSION;

PROVIDE_MODULE static

static const std::string PROVIDE_MODULE;

REQUIRE_BUNDLE static

static const std::string REQUIRE_BUNDLE;

REQUIRE_MODULE static

static const std::string REQUIRE_MODULE;

VERSION static

static const std::string VERSION;