<!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.3.1"/> <title>dmlite: include/dmlite/cpp/catalog.h Source File</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="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">dmlite  <span id="projectnumber">0.6</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c6836824bdef15bafab59627cccf2d55.html">dmlite</a></li><li class="navelem"><a class="el" href="dir_5eb0003806ff55b9e42d6823777110d1.html">cpp</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">catalog.h</div> </div> </div><!--header--> <div class="contents"> <a href="p_2catalog_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/// @file include/dmlite/cpp/catalog.h</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span><span class="comment">/// @brief Catalog API.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span><span class="comment">/// @author Alejandro Álvarez Ayllón <aalvarez@cern.ch></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span><span class="preprocessor">#ifndef DMLITE_CPP_CATALOG_H</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_CPP_CATALOG_H</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../common/config.h"</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="base_8h.html" title="Base interfaces.">base.h</a>"</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="exceptions_8h.html" title="Exceptions used by the API.">exceptions.h</a>"</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="p_2inode_8h.html" title="Low-level access API.">inode.h</a>"</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="extensible_8h.html" title="Extensible types (hold metadata).">utils/extensible.h</a>"</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <dirent.h></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <sys/stat.h></span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <string></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <vector></span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <utime.h></span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>dmlite {</div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// Forward declarations.</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">class </span>StackInstance;</div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">class </span>PluginManager;</div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// Typedef for directories.</span></div> <div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="structdmlite_1_1_directory.html"> 26</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structdmlite_1_1_directory.html" title="Typedef for directories.">Directory</a> { <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_directory.html#af598336524669318f820598e97308eba">~Directory</a>(); };</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment"></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// Interface for Catalog (Namespaces).</span></div> <div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="classdmlite_1_1_catalog.html"> 29</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_catalog.html" title="Interface for Catalog (Namespaces).">Catalog</a>: <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_interface.html" title="Base class for interfaces.">BaseInterface</a> {</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span>: <span class="comment"></span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// Destructor.</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_catalog.html#a98626cb5edbb737699b2906e76c01aad" title="Destructor.">~Catalog</a>();</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// Change the working dir. Future not-absolute paths will use this as root.</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// @param path The new working dir.</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a8311fa9150f1434ee4eb480720aaca1e">changeDir</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment"></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// Get the current working dir.</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// @return The current working dir.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_catalog.html#a19b060993b729a3ad0006e612f3dfa87">getWorkingDir</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// Do an extended stat of a file or directory.</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// @param path The path of the file or directory.</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// @param followSym If true, symlinks will be followed.</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// @return The extended status of the file.</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_extended_stat.html" title="File/directory metadata.">ExtendedStat</a> <a class="code" href="classdmlite_1_1_catalog.html#a38a53f927718f7ef4c514d35081431bb">extendedStat</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">bool</span> followSym = <span class="keyword">true</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// Do an extended stat of a logical file using an associated replica file name.</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// @param rfn The replica.</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// @return The extended status of the file.</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_extended_stat.html" title="File/directory metadata.">ExtendedStat</a> <a class="code" href="classdmlite_1_1_catalog.html#a981eb1f84b0d556dbfb82ca2a2e67752">extendedStatByRFN</a>(<span class="keyword">const</span> std::string& rfn) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// Checks wether the process would be allowed to read, write, or check existence.</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// @param lfn Logical filename.</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// @param mode A mask consisting of one or more of R_OK, W_OK, X_OK and F_OK.</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// @return true if the file can be accessed.</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// @note If the file does not exist, an exception will be thrown.</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlite_1_1_catalog.html#a32a6582efb1f45cb05fca668abc9f6de">access</a>(<span class="keyword">const</span> std::string& path, <span class="keywordtype">int</span> mode) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// Checks wether the process would be allowed to read, write, or check existence.</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// @param rfn Replica filename.</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// @param mode A mask consisting of one or more of R_OK, W_OK, X_OK and F_OK.</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// @return true if the file can be accessed.</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// @note If the file does not exist, an exception will be thrown.</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlite_1_1_catalog.html#a36ec993c21c713448ac4213d47cbbf60">accessReplica</a>(<span class="keyword">const</span> std::string& replica, <span class="keywordtype">int</span> mode) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /// Add a new replica for a file.</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /// @param replica Stores the data that is going to be added. fileid must</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// point to the id of the logical file in the catalog.</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a70456e75b3330b7adcbd0569ffec0564">addReplica</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /// Delete a replica.</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// @param replica The replica to remove.</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a9a9517e0a7d788bbb61fc6cdf1951870">deleteReplica</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /// Get replicas for a file.</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// @param path The file for which replicas will be retrieved.</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> <span class="keyword">virtual</span> std::vector<Replica> <a class="code" href="classdmlite_1_1_catalog.html#aa3631bce44845c0348ba0a3c746987b3">getReplicas</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Creates a new symlink.</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /// @param path The existing path.</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> /// @param symlink The new access path.</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a6c522e7bf8d8cc204fcc3e85f2aa60c0">symlink</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">const</span> std::string& <a class="code" href="classdmlite_1_1_catalog.html#a6c522e7bf8d8cc204fcc3e85f2aa60c0">symlink</a>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment"></span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// Returns the path pointed by the symlink path</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /// @param path The symlink file.</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /// @return The symlink target.</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_catalog.html#aa37778066f5e5dbb0c3da777db57be59">readLink</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> /// Remove a file.</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /// @param path The path to remove.</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#adcc7d8c92466b7bc6a5979a2299cb8d9">unlink</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> /// Creates an entry in the catalog.</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /// @param path The new file.</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /// @param mode The creation mode.</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#ad0e8fdbce5b05c47cfa9cf49a4bf06dd">create</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  mode_t mode) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// Sets the calling process’s file mode creation mask to mask & 0777.</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /// @param mask The new mask.</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /// @return The value of the previous mask.</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span> <span class="keyword">virtual</span> mode_t <a class="code" href="classdmlite_1_1_catalog.html#aac8e86df28c2b4b0ec0f2fe9881c3efd">umask</a>(mode_t mask) <span class="keywordflow">throw</span> ();</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /// Set the mode of a file.</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// @param path The file to modify.</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// @param mode The new mode as an integer (i.e. 0755)</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a27fc6157d63014713cefaeddbaad5aa0">setMode</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  mode_t mode) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"></span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// Set the owner of a file.</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> /// @param path The file to modify.</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> /// @param newUid The uid of the new owneer.</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /// @param newGid The gid of the new group.</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /// @param followSymLink If set to true, symbolic links will be followed.</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a280a19aa4b33bbdf693add4f3a9484ce">setOwner</a>(<span class="keyword">const</span> std::string& path, uid_t newUid, gid_t newGid,</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">bool</span> followSymLink = <span class="keyword">true</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /// Set the size of a file.</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> /// @param path The file to modify.</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /// @param newSize The new file size.</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a362c25a1bb41e46ebc80d1436c06127e">setSize</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">size_t</span> newSize) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> /// Set the checksum of a file.</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /// @param path The file to modify.</span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /// @param csumtype The checksum type (CS, AD or MD).</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /// @param csumvalue The checksum value.</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a5cecf2916d3d0844c6d9aaad54050539">setChecksum</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">const</span> std::string& csumtype,</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">const</span> std::string& csumvalue) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> /// Set the ACLs</span></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /// @param path The file to modify.</span></div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// @param acl The Access Control List.</span></div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a47f6a1e0daa08745fa271a44abacbc7c">setAcl</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">const</span> <a class="code" href="structdmlite_1_1_acl.html">Acl</a>& acl) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /// Set access and/or modification time.</span></div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /// @param path The file path.</span></div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// @param buf A struct holding the new times.</span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a514b87292035eb8259e7d2033bc487db">utime</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> <span class="keyword">struct</span> utimbuf* buf) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span></div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> /// Get the comment associated with a file.</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> /// @param path The file or directory.</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> /// @return The associated comment.</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_catalog.html#a2384c570dca330cf68e09a0e5085aaf9">getComment</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span></div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> /// Set the comment associated with a file.</span></div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> /// @param path The file or directory.</span></div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> /// @param comment The new comment.</span></div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#af42c520a024eba758beb6626df20f1e1">setComment</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">const</span> std::string& comment) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> /// Set GUID of a file.</span></div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> /// @param path The file.</span></div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> /// @param guid The new GUID.</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#aad636d5c21f0443448d041aca9a4e555">setGuid</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">const</span> std::string &guid) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment"></span></div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> /// Update extended metadata on the catalog.</span></div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> /// @param path The file to update.</span></div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> /// @param attr The extended attributes struct.</span></div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a5a7fdcc725276017f0a0211b8b46a542">updateExtendedAttributes</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">const</span> <a class="code" href="structdmlite_1_1_extensible.html" title="Helpful typedef for KeyValue containers.">Extensible</a>& attr) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"></span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> /// Open a directory for reading.</span></div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> /// @param path The directory to open.</span></div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> /// @return A pointer to a handle that can be used for later calls.</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_directory.html" title="Typedef for directories.">Directory</a>* <a class="code" href="classdmlite_1_1_catalog.html#af9a08e61b388b9577697b07b14c20db8">openDir</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"></span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> /// Close a directory opened previously.</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> /// @param dir The directory handle as returned by NsInterface::openDir.</span></div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a433b193065c185643dd4ca33968d91fd">closeDir</a>(<a class="code" href="structdmlite_1_1_directory.html" title="Typedef for directories.">Directory</a>* dir) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> /// Read next entry from a directory (simple read).</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /// @param dir The directory handle as returned by NsInterface::openDir.</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /// @return 0x00 on failure or end of directory.</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">struct </span>dirent* <a class="code" href="classdmlite_1_1_catalog.html#a61ceb68f3c4b5ab0e44428bc78066ee0">readDir</a>(<a class="code" href="structdmlite_1_1_directory.html" title="Typedef for directories.">Directory</a>* dir) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"></span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> /// Read next entry from a directory (stat information added).</span></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> /// @param dir The directory handle as returned by NsInterface::openDir.</span></div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> /// @return 0x00 on failure (and errno is set) or end of directory.</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_extended_stat.html" title="File/directory metadata.">ExtendedStat</a>* <a class="code" href="classdmlite_1_1_catalog.html#a4bc084a5292f0d8923c2f07830191a99">readDirx</a>(<a class="code" href="structdmlite_1_1_directory.html" title="Typedef for directories.">Directory</a>* dir) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"></span></div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> /// Create a new empty directory.</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> /// @param path The path of the new directory.</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> /// @param mode The creation mode.</span></div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#af737501dd69a605cc3b18f1f948b1e37">makeDir</a>(<span class="keyword">const</span> std::string& path,</div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  mode_t mode) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span></div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> /// Rename a file or directory.</span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> /// @param oldPath The old name.</span></div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// @param newPath The new name.</span></div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a49c65898f782b16b2738dd13edc7c23d">rename</a>(<span class="keyword">const</span> std::string& oldPath,</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keyword">const</span> std::string& newPath) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"></span></div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> /// Remove a directory.</span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> /// @param path The path of the directory to remove.</span></div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#ad0b83e72d620908d30a8e91b737ae85a">removeDir</a>(<span class="keyword">const</span> std::string& path) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="comment"></span></div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> /// Get a replica.</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> /// @param rfn The replica file name.</span></div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a> <a class="code" href="classdmlite_1_1_catalog.html#a095fd5375997daa854118c3f86e8a94e">getReplicaByRFN</a>(<span class="keyword">const</span> std::string& rfn) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"></span></div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> /// Update a replica.</span></div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> /// @param replica The replica to modify.</span></div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> /// @return 0 on success, error code otherwise.</span></div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_catalog.html#a15a48657461f07d2a59908600c1b0eea">updateReplica</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_replica.html" title="File replica metadata.">Replica</a>& replica) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  };</div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"></span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> /// Plug-ins must implement a concrete factory to be instantiated.</span></div> <div class="line"><a name="l00216"></a><span class="lineno"><a class="code" href="classdmlite_1_1_catalog_factory.html"> 216</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_catalog_factory.html" title="Plug-ins must implement a concrete factory to be instantiated.">CatalogFactory</a>: <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_factory.html" title="Base class for factories.">BaseFactory</a> {</div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keyword">public</span>:<span class="comment"></span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> /// Virtual destructor</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_catalog_factory.html#a85d58c25883f60ee2035e7c09b845808" title="Virtual destructor.">~CatalogFactory</a>();</div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keyword">protected</span>:</div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="comment">// Stack instance is allowed to instantiate catalogs</span></div> <div class="line"><a name="l00223"></a><span class="lineno"><a class="code" href="classdmlite_1_1_catalog_factory.html#a7653c7bbf485a8f140d1c9d112a59ad9"> 223</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_stack_instance.html">StackInstance</a>; </div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"></span></div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> /// Children of CatalogFactory are allowed to instantiate too (decorator)</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="classdmlite_1_1_catalog.html" title="Interface for Catalog (Namespaces).">Catalog</a>* <a class="code" href="classdmlite_1_1_catalog_factory.html#a5331a04a4ed550c20310890b4dcee6b1" title="Children of CatalogFactory are allowed to instantiate too (decorator)">createCatalog</a>(<a class="code" href="classdmlite_1_1_catalog_factory.html" title="Plug-ins must implement a concrete factory to be instantiated.">CatalogFactory</a>* factory,</div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <a class="code" href="classdmlite_1_1_plugin_manager.html" title="CatalogInterface can only be instantiated through this class.">PluginManager</a>* pm) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"></span></div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> /// Instantiate a implementation of Catalog</span></div> <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_catalog.html" title="Interface for Catalog (Namespaces).">Catalog</a>* <a class="code" href="classdmlite_1_1_catalog_factory.html#a5331a04a4ed550c20310890b4dcee6b1" title="Children of CatalogFactory are allowed to instantiate too (decorator)">createCatalog</a>(<a class="code" href="classdmlite_1_1_plugin_manager.html" title="CatalogInterface can only be instantiated through this class.">PluginManager</a>* pm) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  };</div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div> <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> };</div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#endif // DMLITE_CPP_CATALOG_H</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jul 12 2013 07:34:22 for dmlite by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>