modules_mobile/widget_dao/include/dpl/wrt-dao-ro/plugin_dao_read_only.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  * @file    plugin_dao_read_only.h
  18  * @author  Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  19  * @version 1.0
  20  * @brief   This file contains the declaration of plugin dao read only
  21  */
  22
  23 #ifndef WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_
  24 #define WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_
  25
  26 #include <string>
  27 #include <list>
  28 #include <memory>
  29 #include <dpl/exception.h>
  30 #include <dpl/wrt-dao-ro/common_dao_types.h>
  31
  32 namespace WrtDB {
  33 typedef std::list<DbPluginHandle> PluginHandleList;
  34 typedef std::set<DbPluginHandle> PluginHandleSet;
  35 typedef std::list<std::string> ImplementedObjectsList;
  36 typedef std::shared_ptr<PluginHandleSet> PluginHandleSetPtr;
  37
  38 //TODO make it friend to FeatureDAO or inherit
  39 class PluginDAOReadOnly
  40 {
  41   public:
  42     enum PluginInstallationState
  43     {
  44         INSTALLATION_DEFAULT,
  45         //when plugin data are up to date and plugin model may be created
  46         INSTALLATION_COMPLETED,
  47         //installation is in progress, some data may not be valid
  48         INSTALLATION_IN_PROGRESS,
  49         //installation not completed due to missing dependency
  50         INSTALLATION_WAITING,
  51
  52         UNKNOWN_ERROR
  53     };
  54
  55     static int ToInt(PluginInstallationState state)
  56     {
  57         return static_cast<int>(state);
  58     }
  59
  60     static PluginInstallationState ToState(int state)
  61     {
  62         return static_cast<PluginDAOReadOnly::PluginInstallationState>(state);
  63     }
  64
  65     /**
  66      * PluginDAO Exception classes
  67      */
  68     class Exception
  69     {
  70       public:
  71         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  72         DECLARE_EXCEPTION_TYPE(Base, DatabaseError)
  73         DECLARE_EXCEPTION_TYPE(Base, PluginNotExist)
  74         DECLARE_EXCEPTION_TYPE(Base, PluginInstallationNotCompleted)
  75     };
  76
  77   public:
  78     PluginDAOReadOnly(DbPluginHandle pluginHandle);
  79     PluginDAOReadOnly(const std::string &libraryName);
  80
  81     static PluginHandleList getPluginHandleList();
  82     static PluginHandleList getRootPluginHandleList();
  83
  84     static bool isPluginInstalled(const std::string &libraryName);
  85     static bool isPluginInstalled(DbPluginHandle pluginHandle);
  86
  87     static PluginHandleSetPtr getPluginHandleByStatus(
  88         PluginInstallationState state);
  89
  90     static DbPluginHandle getPluginHandleForImplementedObject(
  91         const std::string& objectName);
  92
  93     static ImplementedObjectsList getImplementedObjects();
  94     static ImplementedObjectsList getImplementedObjectsForPluginHandle(
  95         DbPluginHandle handle);
  96
  97     static PluginObjectsDAO::ObjectsPtr getRequiredObjectsForPluginHandle(
  98         DbPluginHandle handle);
  99
 100     static PluginInstallationState getInstallationStateForHandle(
 101         DbPluginHandle handle);
 102
 103     DbPluginHandle getPluginHandle() const;
 104     PluginInstallationState getInstallationStatus() const;
 105     std::string  getLibraryPath() const;
 106     std::string  getLibraryName() const;
 107     PluginHandleSetPtr getLibraryDependencies() const;
 108
 109   private:
 110     DbPluginHandle m_pluginHandle;
 111
 112     void checkInstallationCompleted();
 113 };
 114 } // namespace WrtDB
 115
 116 #endif /* WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_ */