ApplicationBase.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
#pragma warning(disable : 4251)
 
// OpenTwin header
#include "OTCore/JSON.h"
#include "OTCore/CoreTypes.h"
#include "OTCore/ServiceBase.h"
#include "OTGui/PropertyGridCfg.h"
#include "OTCommunication/ActionTypes.h"
#include "OTCommunication/ActionHandler.h"
#include "OTCommunication/ActionHandleConnector.h"
#include "OTServiceFoundation/FoundationAPIExport.h"
#include "EntityInformation.h"
 
#include "ClassFactory.h"
 
// std header
#include <list>
#include <map>
#include <string>
 
namespace ot {
 
    namespace components {
        class UiComponent;
        class ModelComponent;
    }
    
    namespace intern {
        class ExternalServicesComponent;
    }
 
    class ModalCommandBase;
    class AbstractUiNotifier;
    class AbstractSettingsItem;
    class AbstractModelNotifier;
 
    class OT_SERVICEFOUNDATION_API_EXPORT ApplicationBase : public ServiceBase, public ActionHandler
    {
        OT_DECL_NOCOPY(ApplicationBase)
    public:
        ApplicationBase(const std::string & _serviceName, const std::string & _serviceType, AbstractUiNotifier * _uiNotifier = nullptr, AbstractModelNotifier * _modelNotifier = nullptr);
        virtual ~ApplicationBase();
 
        // ##########################################################################################################################################
 
        // Pure virtual functions
 
        virtual void run(void) = 0;
 
        virtual std::string processAction(const std::string & _action, JsonDocument& _doc) = 0;
        
        virtual std::string processMessage(ServiceBase * _sender, const std::string & _message, JsonDocument& _doc) = 0;
 
        virtual void uiConnected(components::UiComponent * _ui) = 0;
        
        virtual void uiDisconnected(const components::UiComponent * _serviceInfo) = 0;
 
        virtual void modelConnected(components::ModelComponent * _model) = 0;
 
        virtual void modelDisconnected(const components::ModelComponent * _serviceInfo) = 0;
 
        virtual void serviceConnected(ServiceBase * _service) = 0;
 
        virtual void serviceDisconnected(const ServiceBase * _service) = 0;
 
        virtual void preShutdown(void) = 0;
 
        virtual void shuttingDown(void) = 0;
 
        virtual bool startAsRelayService(void) const = 0;
 
        virtual PropertyGridCfg createSettings(void) const = 0;
 
        virtual void settingsSynchronized(const PropertyGridCfg& _config) = 0;
 
        virtual bool settingChanged(const Property* _property) = 0;
 
        virtual std::string deploymentPath(void) const;
 
        virtual void modelSelectionChanged(void) {};
 
        // ####################################################################################################################################################################################################################################################################################
 
        // Setter
 
        void setDataBaseURL(const std::string & _url) { m_databaseURL = _url; }
 
        void setSiteID(const std::string & _id) { m_siteID = _id; }
 
        void setWebSocketURL(const std::string & _url) { m_websocketURL = _url; }
 
        void setDirectoryServiceURL(const std::string& _url);
 
        void setSessionServiceURL(const std::string & _url);
 
        void setSessionID(const std::string & _id);
        
        void setProjectType(const std::string& _type) { m_projectType = _type; };
 
        // ##########################################################################################################################################
 
        // Getter
 
        //void refreshSessionServiceList(void);
 
        std::string dataBaseURL(void) { return m_databaseURL; }
 
        std::string siteID(void) { return m_siteID; }
 
        std::string webSocketURL(void) { return m_websocketURL; }
 
        std::string sessionServiceURL(void) { return m_sessionService.service->getServiceURL(); }
 
        std::string directoryServiceURL(void) { return m_directoryService.service->getServiceURL(); }
 
        std::string sessionID(void) { return m_sessionID; }
        
        const std::string& projectType(void) const { return m_projectType; };
 
        const std::string& getCollectionName() const { return m_collectionName; }
 
        bool isUiConnected(void) const { return m_uiComponent != nullptr; }
 
        bool isModelConnected(void) const { return m_modelComponent != nullptr; }
 
        components::ModelComponent * modelComponent(void) const { return m_modelComponent; }
 
        components::UiComponent * uiComponent(void) const { return m_uiComponent; }
 
        ServiceBase * getConnectedServiceByID(serviceID_t _id);
 
        ServiceBase * getConnectedServiceByName(const std::string & _name);
 
        AbstractUiNotifier * uiNotifier(void) { return m_uiNotifier; }
 
        AbstractModelNotifier * modelNotifier(void) { return m_modelNotifier; }
 
        ClassFactory& getClassFactory(void) { return classFactory; }
 
 
        // ##########################################################################################################################################
 
        // Modal Commands
 
        void addModalCommand(ModalCommandBase *command);
        void removeModalCommand(ModalCommandBase *command);
        std::string processActionWithModalCommands(const std::string & _action, JsonDocument& _doc);
 
        // ##########################################################################################################################################
 
        // IO
 
        void enableMessageQueuing(const std::string & _serviceName, bool _flag);
 
        void flushQueuedHttpRequests(const std::string & _serviceName);
 
        bool sendMessage(bool _queue, const std::string & _serviceName, const JsonDocument& _doc, std::string& _response);
 
        bool sendMessage(bool _queue, const std::string & _serviceName, const JsonDocument& _doc, std::list<std::pair<UID, UID>> & _prefetchIds, std::string& _response);
 
        bool broadcastMessage(bool _queue, const std::string& _message);
 
        bool broadcastMessage(bool _queue, const JsonDocument& _doc);
 
        void prefetchDocumentsFromStorage(const std::list<UID> &entities);
        void prefetchDocumentsFromStorage(const std::list<ot::EntityInformation> &entityInfo);
        UID getPrefetchedEntityVersion(UID entityID);
 
 
        std::string getLogInUserName() const;
        std::string getLogInUserPsw() const;
 
        // ##########################################################################################################################################
    protected:
 
        bool EnsureDataBaseConnection(void);
 
        bool storeSettingToDataBase(const PropertyGridCfg& _config, const std::string& _databaseURL, const std::string& _siteID, const std::string& _userName, const std::string& _userPassword, const std::string& _userCollection);
 
        PropertyGridCfg getSettingsFromDataBase(const std::string& _databaseURL, const std::string& _siteID, const std::string& _userName, const std::string& _userPassword, const std::string& _userCollection);
 
        // ##########################################################################################################################################
 
        // Member
 
        bool                                            m_uiMessageQueuingEnabled;
 
        struct structServiceInformation {
            ServiceBase *   service;
            int             enabledCounter;
            JsonDocument*   doc;
        };
 
        std::map<std::string, structServiceInformation> m_serviceNameMap;
 
        std::map<serviceID_t, structServiceInformation> m_serviceIdMap;
 
        structServiceInformation                        m_sessionService;
        structServiceInformation                        m_directoryService;
        components::ModelComponent *                    m_modelComponent;
        components::UiComponent *                       m_uiComponent;
        AbstractUiNotifier *                            m_uiNotifier;
        AbstractModelNotifier *                         m_modelNotifier;
 
        std::string                                     m_databaseURL;
        std::string                                     m_siteID;
        std::string                                     m_websocketURL;
 
        std::string                                     m_sessionID;
        std::string                                     m_projectName;
        std::string                                     m_collectionName;
        std::string                                     m_projectType;
 
        std::list<ot::ModalCommandBase *>               m_modalCommands;
 
        std::list<UID>                                  m_selectedEntities;
 
        std::map<UID, UID>                              m_prefetchedEntityVersions;
 
        void __serviceConnected(const std::string& _name, const std::string& _type, const std::string& _url, serviceID_t _id);
 
    private:
        friend class intern::ExternalServicesComponent;
 
        OT_HANDLER(handleKeySequenceActivated, ApplicationBase, OT_ACTION_CMD_KeySequenceActivated, ot::SECURE_MESSAGE_TYPES)
        OT_HANDLER(handleSettingsItemChanged, ApplicationBase, OT_ACTION_CMD_UI_SettingsItemChanged, ot::SECURE_MESSAGE_TYPES)
        
        void __serviceDisconnected(const std::string & _name, const std::string & _type, const std::string & _url, serviceID_t _id);
        std::string __processMessage(const std::string & _message, JsonDocument&doc, serviceID_t _senderID);
        void __shuttingDown(bool _requestedAsCommand);
 
        std::string         m_DBuserCollection;
        ClassFactory classFactory;
 
        ApplicationBase() = delete;
    };
 
}