Bundle.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#pragma once
 
#include <memory>
 
#include "celix_bundle.h"
 
namespace celix {
 
    enum class BundleState {
        UNKNOWN,
        UNINSTALLED,
        INSTALLED,
        RESOLVED,
        STARTING,
        STOPPING,
        ACTIVE,
    };
 
    class Bundle {
    public:
        explicit Bundle(celix_bundle_t* _cBnd) : cBnd{_cBnd, [](celix_bundle_t*){/*nop*/}} {}
 
        [[nodiscard]] long getId() const { return celix_bundle_getId(cBnd.get()); }
 
        [[nodiscard]] std::string getEntry(std::string_view path) const {
            std::string result{};
            char* entry = celix_bundle_getEntry(cBnd.get(), path.data());
            if (entry != nullptr) {
                result = std::string{entry};
                free(entry);
            }
            return result;
        }
 
        [[nodiscard]] std::string getManifestValue(std::string_view attribute) const {
            const char* header = celix_bundle_getManifestValue(cBnd.get(), attribute.data());
            return header == nullptr ? std::string{} : std::string{header};
        }
 
        [[nodiscard]] std::string getSymbolicName() const {
            return std::string{celix_bundle_getSymbolicName(cBnd.get())};
        }
 
        [[nodiscard]] std::string getName() const {
            return std::string{celix_bundle_getName(cBnd.get())};
        }
 
        [[nodiscard]] std::string getGroup() const {
            return std::string{celix_bundle_getGroup(cBnd.get())};
        }
 
        [[nodiscard]] std::string getDescription() const {
            return std::string{celix_bundle_getDescription(cBnd.get())};
        }
 
        [[nodiscard]] celix::BundleState getState() const {
            auto cState = celix_bundle_getState(cBnd.get());
            switch (cState) {
                case OSGI_FRAMEWORK_BUNDLE_UNINSTALLED:
                    return BundleState::UNINSTALLED;
                case OSGI_FRAMEWORK_BUNDLE_INSTALLED:
                    return BundleState::INSTALLED;
                case OSGI_FRAMEWORK_BUNDLE_RESOLVED:
                    return BundleState::RESOLVED;
                case OSGI_FRAMEWORK_BUNDLE_STARTING:
                    return BundleState::STARTING;
                case OSGI_FRAMEWORK_BUNDLE_STOPPING:
                    return BundleState::STOPPING;
                case OSGI_FRAMEWORK_BUNDLE_ACTIVE:
                    return BundleState::ACTIVE;
                default:
                    return BundleState::UNKNOWN;
            }
        }
 
        [[nodiscard]] bool isSystemBundle() const {
            return celix_bundle_isSystemBundle(cBnd.get());
        }
    private:
        const std::shared_ptr<celix_bundle_t> cBnd;
    };
}