gateway.h

/*
 * Copyright (C) 2016-2017 Pelagicore AB
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
 * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
 * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 *
 * For further information see LICENSE
 */

#pragma once

#include <string>
#include <exception>

#include "containerabstractinterface.h"
#include "jsonparser.h"
#include "softwarecontainererror.h"

namespace softwarecontainer {

class GatewayError : public SoftwareContainerError
{
public:
    GatewayError():
        SoftwareContainerError("Gateway error.")
    {
    }

    GatewayError(const std::string &message):
        SoftwareContainerError(message)
    {
    }
};

class Gateway
{
    LOG_DECLARE_CLASS_CONTEXT("GATE", "Gateway");

public:
    enum class GatewayState : unsigned int {
        CREATED = 0,
        CONFIGURED = 1,
        ACTIVATED = 2,
    };

    Gateway(const std::string &id,
            std::shared_ptr<ContainerAbstractInterface> container,
            bool isDynamic = false);

    virtual ~Gateway() {}

    virtual std::string id() const;

    virtual bool setConfig(const json_t *config);

    virtual bool activate();

    virtual bool teardown();

    virtual bool isConfigured();

    virtual bool isActivated();

protected:
    virtual bool readConfigElement(const json_t *element) = 0;

    std::shared_ptr<ContainerAbstractInterface> getContainer();

    bool setEnvironmentVariable(const std::string &variable, const std::string &value);

    virtual bool activateGateway() = 0;
    virtual bool teardownGateway() = 0;

    /*
     * Dynamic gateways must set this to true the first time they are activated.
     * This is used by this class to keep track of this, but it should also be expected
     * that inheriting gateway implementations to use this member to keep
     * track of this state as well.
     */
    bool m_activatedOnce;

private:
    std::string m_id;
    std::shared_ptr<ContainerAbstractInterface> m_container;

    // Dynamic gateways must set this on initialization to enable dynamic behavior
    bool m_isDynamic;

    GatewayState m_state;

};

} // namespace softwarecontainer