1 files changed, 125 insertions, 0 deletions
diff --git a/include/CommonAPI/DBus/DBusObjectManagerStub.hpp b/include/CommonAPI/DBus/DBusObjectManagerStub.hpp
new file mode 100644
index 0000000..a16578b
--- /dev/null
+++ b/include/CommonAPI/DBus/DBusObjectManagerStub.hpp
@@ -0,0 +1,125 @@
+// Copyright (C) 2013-2015 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#ifndef COMMONAPI_DBUS_DBUSFREEDESKTOPOBJECTMANAGERSTUB_HPP_
+#define COMMONAPI_DBUS_DBUSFREEDESKTOPOBJECTMANAGERSTUB_HPP_
+
+#include <memory>
+#include <mutex>
+#include <string>
+
+#include <CommonAPI/DBus/DBusInterfaceHandler.hpp>
+
+namespace CommonAPI {
+namespace DBus {
+
+class DBusStubAdapter;
+
+/**
+ * Stub for standard <a href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">org.freedesktop.dbus.ObjectManager</a> interface.
+ *
+ * Instantiated within a manager stub and it must hold reference to all registered objects.
+ * Whenever the manager gets destroyed all references to registered objects are lost too.
+ * This duplicates the semantic of the CommonAPI::ServicePublisher class.
+ *
+ * Only one DBusStubAdapter instance could be registered per DBusObjectManagerStub instance.
+ *
+ * The owner of the DBusObjectManagerStub instance must take care of registering and unregistering it.
+ *
+ * Example stub life cycle:
+ *  - create CommonAPI::ServicePublisher
+ *  - create stub A
+ *  - register stub A to CommonAPI::ServicePublisher
+ *  - create stub B
+ *  - register stub B with stub A as object manager
+ *  - drop all references to stub B, stub A keeps a reference to stub B
+ *  - drop all references to stub A, CommonAPI::ServicePublisher keeps a reference to stub A
+ *  - reference overview: Application > CommonAPI::ServicePublisher > Stub A > Stub B
+ *  - drop all references to CommonAPI::ServicePublisher causes all object references to be dropped
+ */
+class DBusObjectManagerStub : public DBusInterfaceHandler {
+public:
+   // serialization trick: use bool instead of variant since we never serialize it
+	typedef std::unordered_map<std::string, bool> DBusPropertiesChangedDict;
+	typedef std::unordered_map<std::string, DBusPropertiesChangedDict> DBusInterfacesAndPropertiesDict;
+	typedef std::unordered_map<std::string, DBusInterfacesAndPropertiesDict> DBusObjectPathAndInterfacesDict;
+
+public:
+	COMMONAPI_EXPORT DBusObjectManagerStub(const std::string& dbusObjectPath, const std::shared_ptr<DBusProxyConnection>&);
+
+	/**
+	 * Unregisters all currently registered DBusStubAdapter instances from the DBusServicePublisher
+	 */
+	COMMONAPI_EXPORT virtual ~DBusObjectManagerStub();
+
+    /**
+     * Export DBusStubAdapter instance with the current DBusObjectManagerStub instance.
+     *
+     * The DBusStubAdapter must be registered with the DBusServicePublisher!
+     *
+     * On registering a
+     * <a href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">InsterfaceAdded</a>
+     * signal will be emitted with the DBusObjectManagerStub instance's current D-Bus object path.
+     *
+     * @param dbusStubAdapter a refernce to DBusStubAdapter instance
+     *
+     * @return false if the @a dbusStubAdapter instance was already registered
+     * @return false if sending the InterfaceAdded signal fails
+     *
+     * @see ~DBusObjectManagerStub()
+     * @see CommonAPI::ServicePublisher
+     * @see DBusObjectManager
+     */
+	COMMONAPI_EXPORT bool exportManagedDBusStubAdapter(std::shared_ptr<DBusStubAdapter> dbusStubAdapter);
+
+    /**
+     * Unexport DBusStubAdapter instance from this DBusObjectManagerStub instance.
+     *
+     * On unregistering a
+     * <a href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">InsterfaceRemoved</a>
+     * signal will be emitted with the DBusObjectManagerStub instance's current D-Bus object path.
+     *
+     * @param dbusStubAdapter
+     *
+     * @return false if @a dbusStubAdapter wasn't registered
+     * @return true even if sending the InterfaceRemoved signal fails
+     *
+     * @see exportDBusStubAdapter()
+     */
+	COMMONAPI_EXPORT bool unexportManagedDBusStubAdapter(std::shared_ptr<DBusStubAdapter> dbusStubAdapter);
+
+	COMMONAPI_EXPORT bool isDBusStubAdapterExported(std::shared_ptr<DBusStubAdapter> dbusStubAdapter);
+
+	COMMONAPI_EXPORT const std::string& getDBusObjectPath() const;
+	COMMONAPI_EXPORT static const char* getInterfaceName();
+
+	COMMONAPI_EXPORT virtual const char* getMethodsDBusIntrospectionXmlData() const;
+	COMMONAPI_EXPORT virtual bool onInterfaceDBusMessage(const DBusMessage& dbusMessage);
+	COMMONAPI_EXPORT virtual const bool hasFreedesktopProperties();
+
+ private:
+	 COMMONAPI_EXPORT bool registerDBusStubAdapter(std::shared_ptr<DBusStubAdapter> dbusStubAdapter);
+	 COMMONAPI_EXPORT bool unregisterDBusStubAdapter(std::shared_ptr<DBusStubAdapter> dbusStubAdapter);
+
+	 COMMONAPI_EXPORT bool emitInterfacesAddedSignal(std::shared_ptr<DBusStubAdapter> dbusStubAdapter,
+                                   const std::shared_ptr<DBusProxyConnection>& dbusConnection) const;
+
+	 COMMONAPI_EXPORT bool emitInterfacesRemovedSignal(std::shared_ptr<DBusStubAdapter> dbusStubAdapter,
+                                     const std::shared_ptr<DBusProxyConnection>& dbusConnection) const;
+
+    std::string dbusObjectPath_;
+    std::weak_ptr<DBusProxyConnection> dbusConnection_;
+
+    typedef std::unordered_map<std::string, std::shared_ptr<DBusStubAdapter>> DBusInterfacesMap;
+    typedef std::unordered_map<std::string, DBusInterfacesMap> DBusObjectPathsMap;
+    DBusObjectPathsMap registeredDBusObjectPathsMap_;
+
+    std::mutex dbusObjectManagerStubLock_;
+};
+
+} // namespace DBus
+} // namespace CommonAPI
+
+#endif // COMMONAPI_DBUS_DBUSFREEDESKTOPOBJECTMANAGERSTUB_HPP_