xmltooling/util/ReloadableXMLFile.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   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 /**
  18  * @file xmltooling/util/ReloadableXMLFile.h
  19  *
  20  * Base class for file-based XML configuration.
  21  */
  22
  23 #ifndef __xmltooling_reloadable_h__
  24 #define __xmltooling_reloadable_h__
  25
  26 #include <xmltooling/logging.h>
  27 #include <xmltooling/Lockable.h>
  28
  29 #include <ctime>
  30 #include <string>
  31 #include <xercesc/dom/DOM.hpp>
  32
  33 namespace xmltooling {
  34
  35     class XMLTOOL_API RWLock;
  36
  37     /**
  38      * Base class for file-based XML configuration.
  39      */
  40     class XMLTOOL_API ReloadableXMLFile : protected virtual Lockable
  41     {
  42     MAKE_NONCOPYABLE(ReloadableXMLFile);
  43     protected:
  44         /**
  45          * Constructor taking a DOM element supporting the following content:
  46          *
  47          * <dl>
  48          *  <dt>file | filename | path | pathname</dt>
  49          *  <dd>identifies a local file</dd>
  50          *  <dt>uri | url</dt>
  51          *  <dd>identifies a remote resource</dd>
  52          *  <dt>validate</dt>
  53          *  <dd>use a validating parser</dd>
  54          *  <dt>reloadChanges</dt>
  55          *  <dd>enables monitoring of local file for changes</dd>
  56          *  <dt>reloadInterval</dt>
  57          *  <dd>enables periodic refresh of remote file</dd>
  58          *  <dt>backingFilePath</dt>
  59          *  <dd>location for backup of remote resource</dd>
  60          * </dl>
  61          *
  62          * @param e     DOM to supply configuration
  63          * @param log   logging object to use
  64          */
  65         ReloadableXMLFile(const xercesc::DOMElement* e, logging::Category& log);
  66
  67         virtual ~ReloadableXMLFile();
  68
  69         /**
  70          * Loads configuration material.
  71          *
  72          * <p>This method is called to load configuration material
  73          * initially and any time a change is detected. The base version
  74          * performs basic parsing duties and returns the result.
  75          *
  76          * @return a pair consisting of a flag indicating whether to take ownership of
  77          *      the document, and the root element of the tree to load
  78          */
  79         virtual std::pair<bool,xercesc::DOMElement*> load();
  80
  81         /** Root of the original DOM element passed into constructor. */
  82         const xercesc::DOMElement* m_root;
  83
  84         /** Indicates whether resources is local or remote. */
  85         bool m_local;
  86
  87         /** Use a validating parser when parsing XML. */
  88         bool m_validate;
  89
  90         /** Resource location, may be a local path or a URI. */
  91         std::string m_source;
  92
  93         /** Path to backup copy for remote resource. */
  94         std::string m_backing;
  95
  96         /** Last modification of local resource or reload of remote resource. */
  97         time_t m_filestamp;
  98
  99         /** Time in seconds to wait before trying for new copy of remote resource. */
 100         time_t m_reloadInterval;
 101
 102         /** Caching tag associated with remote resource. */
 103         std::string m_cacheTag;
 104
 105         /** Shared lock for guarding reloads. */
 106         RWLock* m_lock;
 107
 108         /** Logging object. */
 109         logging::Category& m_log;
 110
 111     public:
 112         Lockable* lock();
 113         void unlock();
 114
 115     private:
 116         std::pair<bool,xercesc::DOMElement*> load(bool backup);
 117     };
 118
 119 };
 120
 121 #endif /* __xmltooling_reloadable_h__ */