softwarecontainer::DBusGateway Class Reference

Inheritance diagram for softwarecontainer::DBusGateway:

Collaboration diagram for softwarecontainer::DBusGateway:

Public Types
enum	GatewayState : unsigned int { CREATED, CONFIGURED, ACTIVATED }

Public Member Functions
	DBusGateway (const std::string &gatewayDir, std::shared_ptr< ContainerAbstractInterface > container)
virtual bool	setConfig (const json_t *config) override
	Sets config for both dbus session instances. More...
virtual bool	activate () override
	Activates both dbus session instances. More...
virtual bool	readConfigElement (const json_t *) override
	Stubbed since this class only does containment. More...
virtual bool	activateGateway () override
	Stubbed since this class only does containment. More...
virtual bool	teardownGateway () override
	Stubbed since this class only does containment. More...
virtual bool	teardown () override
	Restore system to the state prior to launching of gateway. More...
virtual bool	isConfigured () override
	Is the gateway configured or not? More...
virtual bool	isActivated () override
	Is the gateway activated or not? More...
virtual std::string	id () const
	Returns the ID of the gateway. More...

Static Public Attributes
static constexpr const char *	ID

Protected Member Functions
std::shared_ptr< ContainerAbstractInterface >	getContainer ()
	Get a handle to the associated container. More...
bool	setEnvironmentVariable (const std::string &variable, const std::string &value)
	Set an environment variable in the associated container. More...

Protected Attributes
bool	m_activatedOnce

Detailed Description

Definition at line 27 of file dbusgateway.h.

Member Function Documentation

bool softwarecontainer::DBusGateway::setConfig ( const json_t *  config )

overridevirtual

Sets config for both dbus session instances.

Reimplemented from softwarecontainer::Gateway.

Definition at line 37 of file dbusgateway.cpp.

{
    try {
        log_debug() << "Setting config for dbus session bus";
        bool sessionBusParseResult = sessionBus.setConfig(config);

        log_debug() << "Setting config for dbus system bus";
        bool systemBusParseResult = systemBus.setConfig(config);

        if (!sessionBusParseResult && !systemBusParseResult) {
            log_error() << "Neither session nor system bus could use the given config";
            return false;
        }
    } catch (GatewayParserError &err) {
        log_error() << "Bad config in one of the gateway configurations";
        return false;
    }

     return true;
}

bool softwarecontainer::DBusGateway::activate ( )

overridevirtual

Activates both dbus session instances.

Reimplemented from softwarecontainer::Gateway.

Definition at line 58 of file dbusgateway.cpp.

{
     bool sessionBusActivationResult = false;
     if (sessionBus.isConfigured()) {
         log_debug() << "Activating dbus session bus";
         sessionBusActivationResult = sessionBus.activate();
     }

     bool systemBusActivationResult = false;
     if (systemBus.isConfigured()) {
         log_debug() << "Activating dbus system bus";
         sessionBusActivationResult = systemBus.activate();
     }

     if (!sessionBusActivationResult && !systemBusActivationResult) {
         log_error() << "Neither dbus session bus nor dbus system bus could be activated";
         return false;
     }
     return true;
}

virtual bool softwarecontainer::DBusGateway::readConfigElement ( const json_t *  )

inlineoverridevirtual

Stubbed since this class only does containment.

Implements softwarecontainer::Gateway.

Definition at line 51 of file dbusgateway.h.

{ return true; }

virtual bool softwarecontainer::DBusGateway::activateGateway ( )

inlineoverridevirtual

Stubbed since this class only does containment.

Implements softwarecontainer::Gateway.

Definition at line 56 of file dbusgateway.h.

{ return true; }

virtual bool softwarecontainer::DBusGateway::teardownGateway ( )

inlineoverridevirtual

Stubbed since this class only does containment.

Implements softwarecontainer::Gateway.

Definition at line 61 of file dbusgateway.h.

References isActivated(), isConfigured(), and teardown().

{ return true; }

Here is the call graph for this function:

bool softwarecontainer::DBusGateway::teardown ( )

overridevirtual

Restore system to the state prior to launching of gateway.

Any cleanup code (removal of files, virtual interfaces, etc) should be placed here.

Returns

true upon successful clean-up, false otherwise

Exceptions

GatewayError

If called on a non activated gateway.

Reimplemented from softwarecontainer::Gateway.

Definition at line 79 of file dbusgateway.cpp.

Referenced by teardownGateway().

{
     bool sessionBusTeardownResult;
     if (sessionBus.isActivated()) {
         log_debug() << "Tearing down dbus session bus";
         sessionBusTeardownResult = sessionBus.teardown();
     } else {
         sessionBusTeardownResult = false;
     }

     bool systemBusTeardownResult;
     if (systemBus.isActivated()) {
         log_debug() << "Tearing down dbus system bus";
         systemBusTeardownResult = systemBus.teardown();
     } else {
         systemBusTeardownResult = false;
     }

     if (!sessionBusTeardownResult && !systemBusTeardownResult) {
         log_error() << "Neither dbus session bus nor dbus system bus could be tore down";
         return false;
     }

     return true;
}

Here is the caller graph for this function:

bool softwarecontainer::DBusGateway::isConfigured ( )

overridevirtual

Is the gateway configured or not?

Reimplemented from softwarecontainer::Gateway.

Definition at line 105 of file dbusgateway.cpp.

Referenced by teardownGateway().

{
    return sessionBus.isConfigured() || systemBus.isConfigured();
}

Here is the caller graph for this function:

bool softwarecontainer::DBusGateway::isActivated ( )

overridevirtual

Is the gateway activated or not?

Dynamic gateways will return true if they have been activated at least once. Non-dynamic gateways will return true if they are in state ACTIVATED

Reimplemented from softwarecontainer::Gateway.

Definition at line 110 of file dbusgateway.cpp.

Referenced by teardownGateway().

{
    return sessionBus.isActivated() || systemBus.isActivated();
}

Here is the caller graph for this function:

std::string softwarecontainer::Gateway::id ( ) const

virtualinherited

Returns the ID of the gateway.

Returns

Returns the ID of the gateway as a string

Definition at line 36 of file gateway.cpp.

Referenced by softwarecontainer::Gateway::activate(), softwarecontainer::DBusGatewayInstance::DBusGatewayInstance(), softwarecontainer::Gateway::setConfig(), and softwarecontainer::Gateway::teardown().

{
    return m_id;
}

Here is the caller graph for this function:

std::shared_ptr< ContainerAbstractInterface > softwarecontainer::Gateway::getContainer ( )

protectedinherited

Get a handle to the associated container.

Exceptions

GatewayError

If called before setContainer() has been called.

Definition at line 128 of file gateway.cpp.

Referenced by softwarecontainer::NetworkGateway::activateGateway(), softwarecontainer::DBusGatewayInstance::activateGateway(), softwarecontainer::WaylandGateway::readConfigElement(), and softwarecontainer::NetworkGateway::teardownGateway().

{
    std::shared_ptr<ContainerAbstractInterface> ptrCopy = m_container;
    return ptrCopy;
}

Here is the caller graph for this function:

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

protectedinherited

Set an environment variable in the associated container.

---

The documentation for this class was generated from the following files:

• libsoftwarecontainer/src/gateway/dbus/dbusgateway.h
• libsoftwarecontainer/src/gateway/dbus/dbusgateway.cpp