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.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.2</p>
20<img alt="" src="/images/feather.gif" /></div>
21<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
22<div id="path">
23<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <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">&nbsp;en&nbsp;</a> |
28<a href="/ja/mod/mod_dav_lock.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
29</div>
30<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>
31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>dav_lock_module</td></tr>
33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_dav_lock.c</td></tr>
34<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.1 and later</td></tr></table>
35<h3>Summary</h3>
36
37    <p>This module implements a generic locking API which can be used by any
38    backend provider of <code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code>. It <em>requires</em> at least
39    the service of <code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code>. But without a backend provider
40    which makes use of it, it's useless and should not be loaded into the
41    server. A sample backend module which actually utilizes
42    <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>
43
44    <p>Note that <code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> does <em>not</em> need this
45    generic locking module, because it uses its own more specialized
46    version.</p>
47
48    <p>In order to make <code class="module"><a href="/mod/mod_dav_lock.html">mod_dav_lock</a></code> functional, you just have
49    to specify the location of the lock database using the <code class="directive"><a href="#davgenericlockdb">DavGenericLockDB</a></code> directive described
50    below.</p>
51
52    <div class="note"><h3>Developer's Note</h3>
53      <p>In order to retrieve the pointer to the locking provider function, you
54      have to use the <code>ap_lookup_provider</code> API with the arguments
55      <code>dav-lock</code>, <code>generic</code>, and <code>0</code>.</p>
56    </div>
57</div>
58<div id="quickview"><h3 class="directives">Directives</h3>
59<ul id="toc">
60<li><img alt="" src="/images/down.gif" /> <a href="#davgenericlockdb">DavGenericLockDB</a></li>
61</ul>
62<h3>See also</h3>
63<ul class="seealso">
64<li><code class="module"><a href="/mod/mod_dav.html">mod_dav</a></code></li>
65</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
66
67<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
68<div class="directive-section"><h2><a name="DavGenericLockDB" id="DavGenericLockDB">DavGenericLockDB</a> <a name="davgenericlockdb" id="davgenericlockdb">Directive</a></h2>
69<table class="directive">
70<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the DAV lock database</td></tr>
71<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavGenericLockDB <var>file-path</var></code></td></tr>
72<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
73<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
74<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav_lock</td></tr>
75</table>
76    <p>Use the <code class="directive">DavGenericLockDB</code> directive to specify
77    the full path to the lock database, excluding an extension. If
78    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
79    <code class="module"><a href="/mod/mod_dav_lock.html">mod_dav_lock</a></code> uses a SDBM database to track user
80    locks.</p>
81
82    <div class="example"><h3>Example</h3><p><code>
83      DavGenericLockDB var/DavLock
84    </code></p></div>
85
86    <p>The directory containing the lock database file must be
87    writable by the <code class="directive"><a href="/mod/mpm_common.html#user">User</a></code>
88    and <code class="directive"><a href="/mod/mpm_common.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">&nbsp;en&nbsp;</a> |
100<a href="/ja/mod/mod_dav_lock.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
101</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&amp;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>
102<script type="text/javascript"><!--//--><![CDATA[//><!--
103var comments_shortname = 'httpd';
104var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_dav_lock.html';
105(function(w, d) {
106    if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
107        d.write('<div id="comments_thread"><\/div>');
108        var s = d.createElement('script');
109        s.type = 'text/javascript';
110        s.async = true;
111        s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
112        (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
113    }
114    else { 
115        d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
116    }
117})(window, document);
118//--><!]]></script></div><div id="footer">
119<p class="apache">Copyright 2013 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>
120<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[//><!--
121if (typeof(prettyPrint) !== 'undefined') {
122    prettyPrint();
123}
124//--><!]]></script>
125</body></html>