Multi-line svn commit, see body.

[shibboleth/cpp-xmltooling.git] / xmltooling / util / ReloadableXMLFile.h

diff --git a/xmltooling/util/ReloadableXMLFile.h b/xmltooling/util/ReloadableXMLFile.h
index 019f9b2..cb4c5c3 100644 (file)
--- a/xmltooling/util/ReloadableXMLFile.h
+++ b/xmltooling/util/ReloadableXMLFile.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2006 Internet2
+ *  Copyright 2001-2007 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,11 +23,13 @@
 #ifndef __xmltooling_reloadable_h__
 #define __xmltooling_reloadable_h__
 
+#include <xmltooling/logging.h>
 #include <xmltooling/Lockable.h>
 #include <xmltooling/util/Threads.h>
 
 #include <ctime>
 #include <string>
+#include <xercesc/dom/DOM.hpp>
 
 namespace xmltooling {
 
@@ -50,25 +52,18 @@ namespace xmltooling {
          *  <dt>validate</dt>
          *  <dd>use a validating parser</dd>
          *  <dt>reloadChanges</dt>
-         *  <dd>enables monitoring of resources for changes</dd>
+         *  <dd>enables monitoring of local file for changes</dd>
          * </dl>
          * 
-         * @param e DOM to supply configuration
+         * @param e     DOM to supply configuration
+         * @param log   logging object to use
          */
-        ReloadableXMLFile(const DOMElement* e);
+        ReloadableXMLFile(const xercesc::DOMElement* e, logging::Category& log);
     
         virtual ~ReloadableXMLFile() {
             delete m_lock;
         }
 
-    public:
-        Lockable* lock();
-
-        void unlock() {
-            if (m_lock)
-                m_lock->unlock();
-        }
-
         /**
          * Loads configuration material.
          * 
@@ -79,23 +74,47 @@ namespace xmltooling {
          * @return a pair consisting of a flag indicating whether to take ownership of
          *      the document, and the root element of the tree to load
          */
-        virtual std::pair<bool,DOMElement*> load();
-        
-        /**
-         * Overrideable method to determine whether a remote resource remains valid.
-         * 
-         * @return  true iff the resource remains valid and should not be reloaded
-         */
-        virtual bool isValid() const {
-            return true;
+        virtual std::pair<bool,xercesc::DOMElement*> load() {
+            return load(false);
         }
-
-    private:
-        const DOMElement* m_root;
-        bool m_local, m_validate;
+        
+        /** Root of the original DOM element passed into constructor. */
+        const xercesc::DOMElement* m_root;
+        
+        /** Indicates whether resources is local or remote. */
+        bool m_local;
+        
+        /** Use a validating parser when parsing XML. */
+        bool m_validate;
+        
+        /** Resource location, may be a local path or a URI. */
         std::string m_source;
+
+        /** Path to backup copy for remote resources. */
+        std::string m_backing;
+        
+        /** Last modification of local resource or reload of remote resource. */
         time_t m_filestamp;
+
+        /** Time in seconds to wait before trying for new copy of remote resource. */
+        time_t m_reloadInterval;
+
+        /** Shared lock for guarding reloads. */
         RWLock* m_lock;
+        
+        /** Logging object. */
+        logging::Category& m_log;
+
+    public:
+        Lockable* lock();
+
+        void unlock() {
+            if (m_lock)
+                m_lock->unlock();
+        }
+
+    private:
+        std::pair<bool,xercesc::DOMElement*> load(bool backup);
     };
 
 };