Author: markt
Date: Sat Dec 28 14:32:07 2013
New Revision: 1553838
URL: http://svn.apache.org/r1553838
Log:
Document the track locked files option
Modified:
tomcat/trunk/webapps/docs/config/resources.xml
Modified: tomcat/trunk/webapps/docs/config/resources.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/resources.xml?rev=1553838&r1=1553837&r2=1553838&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/resources.xml (original)
+++ tomcat/trunk/webapps/docs/config/resources.xml Sat Dec 28 14:32:07 2013
@@ -122,6 +122,26 @@
used.</p>
</attribute>
+ <attribute name="trackLockedFiles" required="false">
+ <p>Controls whether the track locked files feature is enabled. If
+ enabled, all calls to methods that return objects that lock a file and
+ need to be closed to release that lock (e.g.
+ <code>ServletContext.getResourceAsStream()</code> will perform a number
+ of additional tasks.</p>
+ <ul>
+ <li>The stack trace at the point where the method was called will be
+ recorded and associated with the returned object.</li>
+ <li>The returned object will be wrapped so that the point where
+ close() (or equivalent) is called to release the resources can be
+ detected. Tracking of the object will cease once the resources have
+ been released.</li>
+ <li>All remaining locked resources on web application shutdown will
be
+ logged and then closed.</li>
+ </ul>
+ <p>If not specified, the default value of <code>false</code> will be
+ used.</p>
+ </attribute>
+
</attributes>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
