configmgr/source/inc/treemanager.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: treemanager.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CONFIGMGR_TREEMANAGER_HXX_
  32 #define CONFIGMGR_TREEMANAGER_HXX_
  33
  34 #include <memory>
  35
  36 #include "salhelper/simplereferenceobject.hxx"
  37
  38 #include "defaultprovider.hxx"
  39 #include "confevents.hxx"
  40 #include "options.hxx"
  41 #include "autoreferencemap.hxx"
  42 #include "autoobject.hxx"
  43
  44 namespace configmgr
  45 {
  46     namespace uno           = ::com::sun::star::uno;
  47
  48     namespace backend {
  49         class CacheController;
  50         class ComponentRequest;
  51         class UpdateRequest;
  52     }
  53     namespace sharable {
  54         struct TreeFragment;
  55         union Node;
  56     }
  57
  58     //==========================================================================
  59     //= TreeManager
  60     //==========================================================================
  61     class CacheClientAccess;
  62     class CacheData;
  63     class ConfigChangeBroadcastHelper;
  64     class ISubtree;
  65     //==========================================================================
  66     class TreeManager: public salhelper::SimpleReferenceObject {
  67         typedef AutoReferenceMap< RequestOptions, CacheClientAccess, lessRequestOptions>    CacheList;
  68
  69         osl::Mutex          m_aCacheControllerMutex;
  70         rtl::Reference< backend::CacheController >     m_xCacheController;
  71
  72         rtl::Reference< backend::CacheController > maybeGetBackendCache() SAL_THROW(());
  73         rtl::Reference< backend::CacheController > getCacheLoader() SAL_THROW((com::sun::star::uno::RuntimeException));
  74         void disposeBackendCache() SAL_THROW(());
  75
  76         CacheList                   m_aCacheList; // Map
  77         AutoObject< CacheData >     m_aTemplates;
  78         sal_Bool            m_bEnableAsync;
  79
  80         virtual ~TreeManager();
  81
  82     public:
  83         /** ctor
  84         */
  85         explicit
  86         TreeManager(rtl::Reference< backend::CacheController > const & _xBackend);
  87
  88         // disposing the cache before destroying
  89         void dispose();
  90
  91         /** requests a node given by it's path. Basicly, this means
  92             that the node is fetch from the cache when it contains it else it ask the server
  93             system into it's cache.
  94             @param                      _rSubtreePath   the path to the node in URI notation.
  95             @param                      _nMinLevels             indicates how many tree levels under the node determined by <arg>_rSubtreePath</arg>
  96                                             should be loaded
  97         */
  98         sharable::Node * requestSubtree(configuration::AbsolutePath const& _rSubtreePath,
  99                                                 RequestOptions const& _aOptions
 100                                                ) SAL_THROW((com::sun::star::uno::Exception));
 101
 102         void updateTree(TreeChangeList& aChanges) SAL_THROW((com::sun::star::uno::Exception));
 103
 104         void saveAndNotifyUpdate(TreeChangeList const& aChanges) SAL_THROW((com::sun::star::uno::Exception));
 105
 106         void releaseSubtree(configuration::AbsolutePath const& aSubtreePath,
 107                                     RequestOptions const& _aOptions ) SAL_THROW(());
 108
 109         void fetchSubtree(  configuration::AbsolutePath const& aSubtreePath,
 110                                     RequestOptions const& _xOptions
 111                                  ) SAL_THROW(());
 112
 113         void refreshAll() SAL_THROW((com::sun::star::uno::Exception));
 114         void flushAll() SAL_THROW(());
 115         void enableAsync(const sal_Bool& bEnableAsync) SAL_THROW(()) ;
 116
 117         sal_Bool fetchDefaultData(  configuration::AbsolutePath const& aSubtreePath,
 118                                             RequestOptions const& _aOptions
 119                                          ) SAL_THROW((com::sun::star::uno::Exception));
 120
 121         std::auto_ptr<ISubtree> requestDefaultData(configuration::AbsolutePath const& aSubtreePath,
 122                                                             const RequestOptions& _aOptions
 123                                                           ) SAL_THROW((com::sun::star::uno::Exception));
 124
 125         sharable::TreeFragment * requestTemplate( rtl::OUString const& aName, rtl::OUString const& aModule
 126                                                   ) SAL_THROW((com::sun::star::uno::Exception));
 127
 128     // implementation interfaces
 129         void refreshSubtree(const configuration::AbsolutePath &_aAbsoluteSubtreePath,
 130                             const RequestOptions& _aOptions) SAL_THROW((com::sun::star::uno::Exception));
 131
 132         void addListener(configuration::AbsolutePath const& aName, const RequestOptions& _aOptions, rtl::Reference<INodeListener> const& pListener);
 133         void removeListener(const RequestOptions& _aOptions, rtl::Reference<INodeListener> const& pListener);
 134
 135         void componentCreated(backend::ComponentRequest const & _aComponent) SAL_THROW(());
 136         void componentChanged(backend::UpdateRequest  const & _anUpdate)     SAL_THROW(());
 137
 138     private:
 139         CacheData & getTemplates() { return * m_aTemplates.get(); }
 140
 141         configuration::AbsolutePath encodeTemplateLocation(rtl::OUString const & _rLogicalTemplateName, rtl::OUString const &_rModule);
 142
 143     private:
 144         rtl::Reference<CacheClientAccess> getCacheAlways(RequestOptions const & _aOptions);
 145
 146         // disposing
 147         void disposeAll();
 148
 149         void fireChanges(TreeChangeList const& _aChanges, sal_Bool _bError);
 150         ConfigChangeBroadcastHelper* getBroadcastHelper(RequestOptions const& _aOptions, bool bCreate);
 151         void disposeBroadcastHelper(ConfigChangeBroadcastHelper* pHelper);
 152
 153         void nodeUpdated(TreeChangeList& _rChanges);
 154     };
 155
 156 }
 157
 158
 159 #endif
 160