xmltooling/util/ReloadableXMLFile.h

   1 /*
   2  *  Copyright 2001-2007 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/Lockable.h>
  27 #include <xmltooling/util/Threads.h>
  28
  29 #include <ctime>
  30 #include <string>
  31 #include <xercesc/dom/DOM.hpp>
  32 #include <log4cpp/Category.hh>
  33
  34 namespace xmltooling {
  35
  36     /**
  37      * Base class for file-based XML configuration.
  38      */
  39     class XMLTOOL_API ReloadableXMLFile : protected virtual Lockable
  40     {
  41         MAKE_NONCOPYABLE(ReloadableXMLFile);
  42
  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 resources for changes</dd>
  56          * </dl>
  57          *
  58          * @param e     DOM to supply configuration
  59          * @param log   logging object to use
  60          */
  61         ReloadableXMLFile(const xercesc::DOMElement* e, log4cpp::Category& log);
  62
  63         virtual ~ReloadableXMLFile() {
  64             delete m_lock;
  65         }
  66
  67         /**
  68          * Loads configuration material.
  69          *
  70          * <p>This method is called to load configuration material
  71          * initially and any time a change is detected. The base version
  72          * performs basic parsing duties and returns the result.
  73          *
  74          * @return a pair consisting of a flag indicating whether to take ownership of
  75          *      the document, and the root element of the tree to load
  76          */
  77         virtual std::pair<bool,xercesc::DOMElement*> load();
  78
  79         /**
  80          * Overrideable method to determine whether a remote resource remains valid.
  81          *
  82          * @return  true iff the resource remains valid and should not be reloaded
  83          */
  84         virtual bool isValid() const {
  85             return true;
  86         }
  87
  88         /** Root of the original DOM element passed into constructor. */
  89         const xercesc::DOMElement* m_root;
  90
  91         /** Indicates whether resources is local or remote. */
  92         bool m_local;
  93
  94         /** Use a validating parser when parsing XML. */
  95         bool m_validate;
  96
  97         /** Resource location, may be a local path or a URI. */
  98         std::string m_source;
  99
 100         /** Last modification of local resource. */
 101         time_t m_filestamp;
 102
 103         /** Shared lock for guarding reloads. */
 104         RWLock* m_lock;
 105
 106         /** Logging object. */
 107         log4cpp::Category& m_log;
 108
 109     public:
 110         Lockable* lock();
 111
 112         void unlock() {
 113             if (m_lock)
 114                 m_lock->unlock();
 115         }
 116     };
 117
 118 };
 119
 120 #endif /* __xmltooling_reloadable_h__ */