1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_dav_lock - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_dav_lock</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_dav_lock.html" title="English"> en </a> | 28<a href="/fr/mod/mod_dav_lock.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_dav_lock.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p> 30</div> 31<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Generic locking module for <code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code></td></tr> 32<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 33<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>dav_lock_module</td></tr> 34<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_dav_lock.c</td></tr> 35<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.1 and later</td></tr></table> 36<h3>Summary</h3> 37 38 <p>This module implements a generic locking API which can be used by any 39 backend provider of <code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code>. It <em>requires</em> at least 40 the service of <code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code>. But without a backend provider 41 which makes use of it, it's useless and should not be loaded into the 42 server. A sample backend module which actually utilizes 43 <code class="module"><a href="/mod/mod_dav_lock.html">mod_dav_lock</a></code> is <a href="http://subversion.apache.org/">mod_dav_svn</a>, the subversion provider module.</p> 44 45 <p>Note that <code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> does <em>not</em> need this 46 generic locking module, because it uses its own more specialized 47 version.</p> 48 49 <p>In order to make <code class="module"><a href="/mod/mod_dav_lock.html">mod_dav_lock</a></code> functional, you just have 50 to specify the location of the lock database using the <code class="directive"><a href="#davgenericlockdb">DavGenericLockDB</a></code> directive described 51 below.</p> 52 53 <div class="note"><h3>Developer's Note</h3> 54 <p>In order to retrieve the pointer to the locking provider function, you 55 have to use the <code>ap_lookup_provider</code> API with the arguments 56 <code>dav-lock</code>, <code>generic</code>, and <code>0</code>.</p> 57 </div> 58</div> 59<div id="quickview"><h3 class="directives">Directives</h3> 60<ul id="toc"> 61<li><img alt="" src="/images/down.gif" /> <a href="#davgenericlockdb">DavGenericLockDB</a></li> 62</ul> 63<h3>See also</h3> 64<ul class="seealso"> 65<li><code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code></li> 66</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 67 68<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 69<div class="directive-section"><h2><a name="DavGenericLockDB" id="DavGenericLockDB">DavGenericLockDB</a> <a name="davgenericlockdb" id="davgenericlockdb">Directive</a></h2> 70<table class="directive"> 71<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the DAV lock database</td></tr> 72<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavGenericLockDB <var>file-path</var></code></td></tr> 73<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 74<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 75<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav_lock</td></tr> 76</table> 77 <p>Use the <code class="directive">DavGenericLockDB</code> directive to specify 78 the full path to the lock database, excluding an extension. If 79 the path is not absolute, it will be interpreted relative to <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code>. The implementation of 80 <code class="module"><a href="/mod/mod_dav_lock.html">mod_dav_lock</a></code> uses a SDBM database to track user 81 locks.</p> 82 83 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">DavGenericLockDB var/DavLock</pre> 84</div> 85 86 <p>The directory containing the lock database file must be 87 writable by the <code class="directive"><a href="/mod/mod_unixd.html#user">User</a></code> 88 and <code class="directive"><a href="/mod/mod_unixd.html#group">Group</a></code> under which 89 Apache is running. For security reasons, you should create a 90 directory for this purpose rather than changing the permissions on 91 an existing directory. In the above example, Apache will create 92 files in the <code>var/</code> directory under the <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code> with the base filename 93 <code>DavLock</code> and an extension added by the server.</p> 94 95 96</div> 97</div> 98<div class="bottomlang"> 99<p><span>Available Languages: </span><a href="/en/mod/mod_dav_lock.html" title="English"> en </a> | 100<a href="/fr/mod/mod_dav_lock.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 101<a href="/ja/mod/mod_dav_lock.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p> 102</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 103<script type="text/javascript"><!--//--><![CDATA[//><!-- 104var comments_shortname = 'httpd'; 105var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_dav_lock.html'; 106(function(w, d) { 107 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 108 d.write('<div id="comments_thread"><\/div>'); 109 var s = d.createElement('script'); 110 s.type = 'text/javascript'; 111 s.async = true; 112 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 113 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 114 } 115 else { 116 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 117 } 118})(window, document); 119//--><!]]></script></div><div id="footer"> 120<p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> 121<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 122if (typeof(prettyPrint) !== 'undefined') { 123 prettyPrint(); 124} 125//--><!]]></script> 126</body></html>
