<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xmltooling: xmltooling::ReloadableXMLFile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">xmltooling
 <span id="projectnumber">1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00070.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="a00300.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::ReloadableXMLFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for file-based XML configuration.
<a href="a00070.html#details">More...</a></p>
<p><code>#include <xmltooling/util/ReloadableXMLFile.h></code></p>
<div class="dynheader">
Inheritance diagram for xmltooling::ReloadableXMLFile:</div>
<div class="dyncontent">
<div class="center">
<img src="a00070.png" usemap="#xmltooling::ReloadableXMLFile_map" alt=""/>
<map id="xmltooling::ReloadableXMLFile_map" name="xmltooling::ReloadableXMLFile_map">
<area href="a00049.html" title="Abstract mixin interface for interfaces that support locking. " alt="xmltooling::Lockable" shape="rect" coords="0,0,184,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0ab6ec8160691b536a5f22816d1fc6a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Lockable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a0ab6ec8160691b536a5f22816d1fc6a8">lock</a> ()</td></tr>
<tr class="memdesc:a0ab6ec8160691b536a5f22816d1fc6a8"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00048.html" title="RAII wrapper for a mutex lock. ">Lock</a> the associated object for exclusive access. <a href="#a0ab6ec8160691b536a5f22816d1fc6a8">More...</a><br/></td></tr>
<tr class="separator:a0ab6ec8160691b536a5f22816d1fc6a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a22afbcef62d60c6c193e857760b82f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a22afbcef62d60c6c193e857760b82f"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a6a22afbcef62d60c6c193e857760b82f">unlock</a> ()</td></tr>
<tr class="memdesc:a6a22afbcef62d60c6c193e857760b82f"><td class="mdescLeft"> </td><td class="mdescRight">Unlock the associated object from exclusive access. <br/></td></tr>
<tr class="separator:a6a22afbcef62d60c6c193e857760b82f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa15396c16e5bcac32423a6a6ab72b507"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#aa15396c16e5bcac32423a6a6ab72b507">ReloadableXMLFile</a> (const xercesc::DOMElement *e, logging::Category &log, bool startReloadThread=true)</td></tr>
<tr class="memdesc:aa15396c16e5bcac32423a6a6ab72b507"><td class="mdescLeft"> </td><td class="mdescRight">Constructor taking a DOM element supporting the following content: <a href="#aa15396c16e5bcac32423a6a6ab72b507">More...</a><br/></td></tr>
<tr class="separator:aa15396c16e5bcac32423a6a6ab72b507"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cb7313ad14ed3673fb6de5bebaac8ff"><td class="memItemLeft" align="right" valign="top">virtual std::pair< bool, <br class="typebreak"/>
xercesc::DOMElement * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a4cb7313ad14ed3673fb6de5bebaac8ff">background_load</a> ()</td></tr>
<tr class="memdesc:a4cb7313ad14ed3673fb6de5bebaac8ff"><td class="mdescLeft"> </td><td class="mdescRight">Loads configuration material. <a href="#a4cb7313ad14ed3673fb6de5bebaac8ff">More...</a><br/></td></tr>
<tr class="separator:a4cb7313ad14ed3673fb6de5bebaac8ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab323630dc7c233db6a7556a2d518ab1e"><td class="memItemLeft" align="right" valign="top">virtual std::pair< bool, <br class="typebreak"/>
xercesc::DOMElement * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#ab323630dc7c233db6a7556a2d518ab1e">load</a> ()</td></tr>
<tr class="separator:ab323630dc7c233db6a7556a2d518ab1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a327de7693392f04cbce29e3faaab4257"><td class="memItemLeft" align="right" valign="top">virtual std::pair< bool, <br class="typebreak"/>
xercesc::DOMElement * > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a327de7693392f04cbce29e3faaab4257">load</a> (bool backup)</td></tr>
<tr class="memdesc:a327de7693392f04cbce29e3faaab4257"><td class="mdescLeft"> </td><td class="mdescRight">Basic load/parse of configuration material. <a href="#a327de7693392f04cbce29e3faaab4257">More...</a><br/></td></tr>
<tr class="separator:a327de7693392f04cbce29e3faaab4257"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25dedb5f2a42a870110e62c0c83b9100"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00049.html">Lockable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a25dedb5f2a42a870110e62c0c83b9100">getBackupLock</a> ()</td></tr>
<tr class="memdesc:a25dedb5f2a42a870110e62c0c83b9100"><td class="mdescLeft"> </td><td class="mdescRight">Accesses a lock interface protecting use of backup file associated with the object. <a href="#a25dedb5f2a42a870110e62c0c83b9100">More...</a><br/></td></tr>
<tr class="separator:a25dedb5f2a42a870110e62c0c83b9100"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2b4ed7f9f2651eaefb1e75f916a8d5b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2b4ed7f9f2651eaefb1e75f916a8d5b"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#ae2b4ed7f9f2651eaefb1e75f916a8d5b">preserveCacheTag</a> ()</td></tr>
<tr class="memdesc:ae2b4ed7f9f2651eaefb1e75f916a8d5b"><td class="mdescLeft"> </td><td class="mdescRight">Preserves the last remote resource caching identifier in a backup file for use on the next restart. <br/></td></tr>
<tr class="separator:ae2b4ed7f9f2651eaefb1e75f916a8d5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ae0408dfa23f9dbfbe73a7be90f2fed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ae0408dfa23f9dbfbe73a7be90f2fed"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a3ae0408dfa23f9dbfbe73a7be90f2fed">startup</a> ()</td></tr>
<tr class="memdesc:a3ae0408dfa23f9dbfbe73a7be90f2fed"><td class="mdescLeft"> </td><td class="mdescRight">Starts up reload thread, can be automatically called by constructor, or manually invoked by subclass. <br/></td></tr>
<tr class="separator:a3ae0408dfa23f9dbfbe73a7be90f2fed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33b7acd9f029d35939f2b96db1a0c20a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33b7acd9f029d35939f2b96db1a0c20a"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a33b7acd9f029d35939f2b96db1a0c20a">shutdown</a> ()</td></tr>
<tr class="memdesc:a33b7acd9f029d35939f2b96db1a0c20a"><td class="mdescLeft"> </td><td class="mdescRight">Shuts down reload thread, should be called from subclass destructor. <br/></td></tr>
<tr class="separator:a33b7acd9f029d35939f2b96db1a0c20a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a871c01f825293101746216ca48bac451"><td class="memItemLeft" align="right" valign="top">const xercesc::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a871c01f825293101746216ca48bac451">m_root</a></td></tr>
<tr class="memdesc:a871c01f825293101746216ca48bac451"><td class="mdescLeft"> </td><td class="mdescRight">Root of the original DOM element passed into constructor. <a href="#a871c01f825293101746216ca48bac451">More...</a><br/></td></tr>
<tr class="separator:a871c01f825293101746216ca48bac451"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2fabed40789d9d06819875123181d1b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#ac2fabed40789d9d06819875123181d1b">m_local</a></td></tr>
<tr class="memdesc:ac2fabed40789d9d06819875123181d1b"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether resources is local or remote. <a href="#ac2fabed40789d9d06819875123181d1b">More...</a><br/></td></tr>
<tr class="separator:ac2fabed40789d9d06819875123181d1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af337f78843ec483fd653ed7d7271bc53"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#af337f78843ec483fd653ed7d7271bc53">m_validate</a></td></tr>
<tr class="memdesc:af337f78843ec483fd653ed7d7271bc53"><td class="mdescLeft"> </td><td class="mdescRight">Use a validating parser when parsing XML. <a href="#af337f78843ec483fd653ed7d7271bc53">More...</a><br/></td></tr>
<tr class="separator:af337f78843ec483fd653ed7d7271bc53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa66e3bef51741040c0defebd01848b8a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#aa66e3bef51741040c0defebd01848b8a">m_source</a></td></tr>
<tr class="memdesc:aa66e3bef51741040c0defebd01848b8a"><td class="mdescLeft"> </td><td class="mdescRight">Resource location, may be a local path or a URI. <a href="#aa66e3bef51741040c0defebd01848b8a">More...</a><br/></td></tr>
<tr class="separator:aa66e3bef51741040c0defebd01848b8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafa1c06443ceae513414c2abe319681a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#aafa1c06443ceae513414c2abe319681a">m_backing</a></td></tr>
<tr class="memdesc:aafa1c06443ceae513414c2abe319681a"><td class="mdescLeft"> </td><td class="mdescRight">Path to backup copy for remote resource. <a href="#aafa1c06443ceae513414c2abe319681a">More...</a><br/></td></tr>
<tr class="separator:aafa1c06443ceae513414c2abe319681a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86d36200e2ece81dbd5eb39da4a84a3a"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a86d36200e2ece81dbd5eb39da4a84a3a">m_filestamp</a></td></tr>
<tr class="memdesc:a86d36200e2ece81dbd5eb39da4a84a3a"><td class="mdescLeft"> </td><td class="mdescRight">Last modification of local resource. <a href="#a86d36200e2ece81dbd5eb39da4a84a3a">More...</a><br/></td></tr>
<tr class="separator:a86d36200e2ece81dbd5eb39da4a84a3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a968c46dcf9fd89a4ec30f3fb94e25acd"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a968c46dcf9fd89a4ec30f3fb94e25acd">m_reloadInterval</a></td></tr>
<tr class="memdesc:a968c46dcf9fd89a4ec30f3fb94e25acd"><td class="mdescLeft"> </td><td class="mdescRight">Time in seconds to wait before trying for new copy of remote resource. <a href="#a968c46dcf9fd89a4ec30f3fb94e25acd">More...</a><br/></td></tr>
<tr class="separator:a968c46dcf9fd89a4ec30f3fb94e25acd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add0d7e54a10dec7c75d90ace444f509b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#add0d7e54a10dec7c75d90ace444f509b">m_cacheTag</a></td></tr>
<tr class="memdesc:add0d7e54a10dec7c75d90ace444f509b"><td class="mdescLeft"> </td><td class="mdescRight">Caching tag associated with remote resource. <a href="#add0d7e54a10dec7c75d90ace444f509b">More...</a><br/></td></tr>
<tr class="separator:add0d7e54a10dec7c75d90ace444f509b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e66bb693f895cc2589ad12a6120d43f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00072.html">RWLock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a3e66bb693f895cc2589ad12a6120d43f">m_lock</a></td></tr>
<tr class="memdesc:a3e66bb693f895cc2589ad12a6120d43f"><td class="mdescLeft"> </td><td class="mdescRight">Shared lock for guarding reloads. <a href="#a3e66bb693f895cc2589ad12a6120d43f">More...</a><br/></td></tr>
<tr class="separator:a3e66bb693f895cc2589ad12a6120d43f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e59323a1742b90b3a2a9d25a4e71e44"><td class="memItemLeft" align="right" valign="top">logging::Category & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a0e59323a1742b90b3a2a9d25a4e71e44">m_log</a></td></tr>
<tr class="memdesc:a0e59323a1742b90b3a2a9d25a4e71e44"><td class="mdescLeft"> </td><td class="mdescRight">Logging object. <a href="#a0e59323a1742b90b3a2a9d25a4e71e44">More...</a><br/></td></tr>
<tr class="separator:a0e59323a1742b90b3a2a9d25a4e71e44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63e6fc0337ffe933593fc046644d6f49"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a63e6fc0337ffe933593fc046644d6f49">m_id</a></td></tr>
<tr class="memdesc:a63e6fc0337ffe933593fc046644d6f49"><td class="mdescLeft"> </td><td class="mdescRight">Plugin identifier. <a href="#a63e6fc0337ffe933593fc046644d6f49">More...</a><br/></td></tr>
<tr class="separator:a63e6fc0337ffe933593fc046644d6f49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b878015cda49c2541936d8ce9d89250"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a9b878015cda49c2541936d8ce9d89250">m_loaded</a></td></tr>
<tr class="memdesc:a9b878015cda49c2541936d8ce9d89250"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a usable version of the resource is in place. <a href="#a9b878015cda49c2541936d8ce9d89250">More...</a><br/></td></tr>
<tr class="separator:a9b878015cda49c2541936d8ce9d89250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70f0ed287b1d6f78fb5c17a34071ca4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00026.html">CredentialResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a70f0ed287b1d6f78fb5c17a34071ca4c">m_credResolver</a></td></tr>
<tr class="memdesc:a70f0ed287b1d6f78fb5c17a34071ca4c"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00026.html" title="An API for resolving keys and certificates based on application criteria. ">CredentialResolver</a> for signature verification. <a href="#a70f0ed287b1d6f78fb5c17a34071ca4c">More...</a><br/></td></tr>
<tr class="separator:a70f0ed287b1d6f78fb5c17a34071ca4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8472ba0bda01a45357549665f2bc4b01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00078.html">SignatureTrustEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a8472ba0bda01a45357549665f2bc4b01">m_trust</a></td></tr>
<tr class="memdesc:a8472ba0bda01a45357549665f2bc4b01"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> for signature verification. <a href="#a8472ba0bda01a45357549665f2bc4b01">More...</a><br/></td></tr>
<tr class="separator:a8472ba0bda01a45357549665f2bc4b01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e62b9d1ec12ce1edf3029615caa8213"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00070.html#a4e62b9d1ec12ce1edf3029615caa8213">m_signerName</a></td></tr>
<tr class="memdesc:a4e62b9d1ec12ce1edf3029615caa8213"><td class="mdescLeft"> </td><td class="mdescRight">Name of signer for signature verification. <a href="#a4e62b9d1ec12ce1edf3029615caa8213">More...</a><br/></td></tr>
<tr class="separator:a4e62b9d1ec12ce1edf3029615caa8213"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for file-based XML configuration. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa15396c16e5bcac32423a6a6ab72b507"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xmltooling::ReloadableXMLFile::ReloadableXMLFile </td>
<td>(</td>
<td class="paramtype">const xercesc::DOMElement * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">logging::Category & </td>
<td class="paramname"><em>log</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>startReloadThread</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor taking a DOM element supporting the following content: </p>
<dl>
<dt>file | filename | path | pathname </dt>
<dd>identifies a local file </dd>
<dt>uri | url </dt>
<dd>identifies a remote resource </dd>
<dt>validate </dt>
<dd>use a validating parser </dd>
<dt>reloadChanges </dt>
<dd>enables monitoring of local file for changes </dd>
<dt>reloadInterval or maxRefreshDelay </dt>
<dd>enables periodic refresh of remote file </dd>
<dt>backingFilePath </dt>
<dd>location for backup of remote resource </dd>
<dt>id </dt>
<dd>identifies the plugin instance for logging purposes </dd>
<dt>certificate </dt>
<dd>requires XML be signed with an enveloped signature verifiable with specified key </dd>
<dt>signerName </dt>
<dd>requires XML be signed with an enveloped signature verifiable with <<a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a>> by certificate containing this name </dd>
<dt><<a class="el" href="a00026.html" title="An API for resolving keys and certificates based on application criteria. ">CredentialResolver</a>> </dt>
<dd>requires XML be signed with an enveloped signature verifiable with specified key </dd>
<dt><<a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a>> </dt>
<dd>requires XML be signed with an enveloped signature verifiable with specified <a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>DOM to supply configuration </td></tr>
<tr><td class="paramname">log</td><td>logging object to use </td></tr>
<tr><td class="paramname">startReloadThread</td><td>true iff refresh thread for resources should be started by constructor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4cb7313ad14ed3673fb6de5bebaac8ff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::pair<bool,xercesc::DOMElement*> xmltooling::ReloadableXMLFile::background_load </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads configuration material. </p>
<p>This method is called to load configuration material initially and any time a change is detected. The base version performs basic parsing duties and returns the result.</p>
<p>This method is not called with the object locked, so actual modification of implementation state requires explicit locking within the method override.</p>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a flag indicating whether to take ownership of the document, and the root element of the tree to load </dd></dl>
</div>
</div>
<a class="anchor" id="a25dedb5f2a42a870110e62c0c83b9100"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00049.html">Lockable</a>* xmltooling::ReloadableXMLFile::getBackupLock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Accesses a lock interface protecting use of backup file associated with the object. </p>
<p>The lock is <b>NOT</b> acquired automatically.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to a lock interface, or nullptr if unnecessary </dd></dl>
</div>
</div>
<a class="anchor" id="ab323630dc7c233db6a7556a2d518ab1e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::pair<bool,xercesc::DOMElement*> xmltooling::ReloadableXMLFile::load </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="a00207.html#_deprecated000005">Deprecated:</a></b></dt><dd>Basic load/parse of configuration material.</dd></dl>
<p>The base version performs basic parsing duties and returns the result. Subclasses should override the new <a class="el" href="a00070.html#a4cb7313ad14ed3673fb6de5bebaac8ff" title="Loads configuration material. ">background_load()</a> method and perform their own locking in conjunction with use of this method.</p>
<p>Subclasses that continue to override this method will function, but a write lock will be acquired and held for the entire operation.</p>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a flag indicating whether to take ownership of the document, and the root element of the tree to load </dd></dl>
</div>
</div>
<a class="anchor" id="a327de7693392f04cbce29e3faaab4257"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::pair<bool,xercesc::DOMElement*> xmltooling::ReloadableXMLFile::load </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>backup</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic load/parse of configuration material. </p>
<p>The base version performs basic parsing duties and returns the result. Subclasses should override the new <a class="el" href="a00070.html#a4cb7313ad14ed3673fb6de5bebaac8ff" title="Loads configuration material. ">background_load()</a> method and perform their own locking in conjunction with use of this method.</p>
<p>This version allows subclasses to explicitly control the use of a backup for remote resources, which allows additional validation to be performed besides just successful XML parsing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">backup</td><td>true iff the backup source should be loaded </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pair consisting of a flag indicating whether to take ownership of the document, and the root element of the tree to load </dd></dl>
</div>
</div>
<a class="anchor" id="a0ab6ec8160691b536a5f22816d1fc6a8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Lockable</a>* xmltooling::ReloadableXMLFile::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00048.html" title="RAII wrapper for a mutex lock. ">Lock</a> the associated object for exclusive access. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the object being locked </dd></dl>
<p>Implements <a class="el" href="a00049.html#a86337f8560d321f90662de5751764759">xmltooling::Lockable</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aafa1c06443ceae513414c2abe319681a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string xmltooling::ReloadableXMLFile::m_backing</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Path to backup copy for remote resource. </p>
</div>
</div>
<a class="anchor" id="add0d7e54a10dec7c75d90ace444f509b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string xmltooling::ReloadableXMLFile::m_cacheTag</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Caching tag associated with remote resource. </p>
</div>
</div>
<a class="anchor" id="a70f0ed287b1d6f78fb5c17a34071ca4c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00026.html">CredentialResolver</a>* xmltooling::ReloadableXMLFile::m_credResolver</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00026.html" title="An API for resolving keys and certificates based on application criteria. ">CredentialResolver</a> for signature verification. </p>
</div>
</div>
<a class="anchor" id="a86d36200e2ece81dbd5eb39da4a84a3a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">time_t xmltooling::ReloadableXMLFile::m_filestamp</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Last modification of local resource. </p>
</div>
</div>
<a class="anchor" id="a63e6fc0337ffe933593fc046644d6f49"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string xmltooling::ReloadableXMLFile::m_id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Plugin identifier. </p>
</div>
</div>
<a class="anchor" id="a9b878015cda49c2541936d8ce9d89250"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool xmltooling::ReloadableXMLFile::m_loaded</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether a usable version of the resource is in place. </p>
</div>
</div>
<a class="anchor" id="ac2fabed40789d9d06819875123181d1b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool xmltooling::ReloadableXMLFile::m_local</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether resources is local or remote. </p>
</div>
</div>
<a class="anchor" id="a3e66bb693f895cc2589ad12a6120d43f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00072.html">RWLock</a>* xmltooling::ReloadableXMLFile::m_lock</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared lock for guarding reloads. </p>
</div>
</div>
<a class="anchor" id="a0e59323a1742b90b3a2a9d25a4e71e44"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">logging::Category& xmltooling::ReloadableXMLFile::m_log</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Logging object. </p>
</div>
</div>
<a class="anchor" id="a968c46dcf9fd89a4ec30f3fb94e25acd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">time_t xmltooling::ReloadableXMLFile::m_reloadInterval</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Time in seconds to wait before trying for new copy of remote resource. </p>
</div>
</div>
<a class="anchor" id="a871c01f825293101746216ca48bac451"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const xercesc::DOMElement* xmltooling::ReloadableXMLFile::m_root</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Root of the original DOM element passed into constructor. </p>
</div>
</div>
<a class="anchor" id="a4e62b9d1ec12ce1edf3029615caa8213"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string xmltooling::ReloadableXMLFile::m_signerName</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of signer for signature verification. </p>
</div>
</div>
<a class="anchor" id="aa66e3bef51741040c0defebd01848b8a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string xmltooling::ReloadableXMLFile::m_source</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resource location, may be a local path or a URI. </p>
</div>
</div>
<a class="anchor" id="a8472ba0bda01a45357549665f2bc4b01"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00078.html">SignatureTrustEngine</a>* xmltooling::ReloadableXMLFile::m_trust</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> for signature verification. </p>
</div>
</div>
<a class="anchor" id="af337f78843ec483fd653ed7d7271bc53"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool xmltooling::ReloadableXMLFile::m_validate</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Use a validating parser when parsing XML. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/util/<a class="el" href="a00186.html">ReloadableXMLFile.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00070.html">ReloadableXMLFile</a></li>
<li class="footer">Generated on Wed Sep 2 2015 18:20:35 for xmltooling by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
