adammurdoch 2003/02/23 23:32:40
Modified: vfs/xdocs api.xml todo.xml
vfs project.properties
Log:
- Details about new elements in config file.
- More todos.
- Add last published date to generated docs.
Revision Changes Path
1.6 +34 -4 jakarta-commons-sandbox/vfs/xdocs/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/api.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- api.xml 21 Feb 2003 05:17:18 -0000 1.5
+++ api.xml 24 Feb 2003 07:32:40 -0000 1.6
@@ -94,7 +94,7 @@
Here are the steps for using <code>DefaultFileSystemManager</code>:
</p>
<ol>
- <li>Create an new instance.</li>
+ <li>Create a new instance.</li>
<li>
Set the logger for the manager and all its components,
using <code>setLogger()</code>. This step is
@@ -152,10 +152,16 @@
The configuration file is an XML file. The root element
of the configuration file should be a
<code><providers></code> element.
- The <code><providers></code> element may contain
- zero or more <code><provider></code> elements, and
- an optional <code><default-provider></code> element.
+ The <code><providers></code> element may contain:
</p>
+ <ul>
+ <li>Zero or more <code><provider></code> elements.</li>
+ <li>An optional <code><default-provider></code>
element.</li>
+ <li>Zero or more <code><extension-map></code>
elements.</li>
+ <li>Zero or more <code><mime-type-map></code>
elements.</li>
+ </ul>
+
+ <p><b><code><provider></code></b></p>
<p>
The <code><provider></code> element defines a file
provider. It must have a <code>class-name</code> attribute,
@@ -181,12 +187,34 @@
specifies the fully qualified name of a class to test for.
If the class cannot be found, the provider is not registered.
</p>
+
+ <p><b><code><default-provider></code></b></p>
<p>
The <code><default-provider></code> element defines
the default provider. It has the same format as the
<code><provider></code> element.
</p>
+ <p><b><code><extension-map></code></b></p>
+ <p>
+ The <code><extension-map></code> element defines
+ a mapping from a file's extension to the provider that
+ should handle files with that extension.
+ It must have an <code>extension</code> attribute, which
+ specifies the extension, and a <code>scheme</code> attribute,
+ which specifies the URI scheme of the provider.
+ </p>
+
+ <p><b><code><mime-type-map></code></b></p>
+ <p>
+ The <code><mime-type-map></code> element defines
+ a mapping from a file's MIME type to the provider that
+ should handle files with that MIME type.
+ It must have an <code>mime-type</code> attribute, which
+ specifies the MIME type, and a <code>scheme</code> attribute,
+ which specified the URI scheme of the provider.
+ </p>
+
<p>
Below is an example configuration file:
</p>
@@ -195,6 +223,8 @@
<provider class-name="org.apache.commons.vfs.provider.zip.ZipFileProvider">
<scheme name="zip"/>
</provider>
+ <extension-map extension="zip" scheme="zip"/>
+ <mime-type-map mime-type="application/zip" scheme="zip"/>
<provider class-name="org.apache.commons.vfs.provider.ftp.FtpFileProvider">
<scheme name="ftp"/>
<if-available class-name="org.apache.commons.net.ftp.FTPFile"/>
1.7 +26 -2 jakarta-commons-sandbox/vfs/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/todo.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- todo.xml 20 Feb 2003 07:33:54 -0000 1.6
+++ todo.xml 24 Feb 2003 07:32:40 -0000 1.7
@@ -38,11 +38,14 @@
<li>WebDAV Provider:
<ul>
<li>Add plain http support, and auto-detect dav
resources.</li>
+ <li>Support attributes.</li>
+ <li>Support last-modified.</li>
</ul>
</li>
<li>SFTP Provider:
<ul>
<li>Add key-based authentication.</li>
+ <li>Support last-modified.</li>
</ul>
</li>
<li>Zip/Jar Provider:
@@ -56,6 +59,22 @@
<li>Add support for writing to zip/jar files.</li>
</ul>
</li>
+ <li>FTP Provider:
+ <ul>
+ <li>Support last-modified.</li>
+ </ul>
+ </li>
+ <li>SMB Provider:
+ <ul>
+ <li>Support last-modified.</li>
+ </ul>
+ </li>
+ <li>URL Provider:
+ <ul>
+ <li>Support attributes.</li>
+ <li>Support last-modified.</li>
+ </ul>
+ </li>
<li>
The in-memory caching mechanism is pretty rudimentary at
this stage. It needs work to make it size capped. In addition,
@@ -98,17 +117,22 @@
case-insensitive file systems, symbolic links, name mangling,
etc).</li>
<li>Add more selectors: XPath, Ant style, regular expression.</li>
<li>Add adaptor (NodePointerFactory?) for use with JXpath.</li>
- <li>Add contentChanged event to FileListener.</li>
+ <li>
+ Add content-changed, attribute-changed, and move events to
+ FileListener. Maybe split into structure and content
+ listeners.
+ </li>
<li>Provide a hook for authentication.</li>
+ <li>Get/set the file permisions.</li>
<li>Sort out threading model.</li>
<li>Add a file monitor, that watches for external changes to
files.</li>
+ <li>Add a DefaultFileSystemManager subclass that is an Avalon
component.</li>
<li>
Look at adding native code for fine-grained control over
permissions, file monitoring, faster moves, etc. Must be
optional - the thing should still build and run without the
native code.
</li>
- <li>Add a DefaultFileSystemManager subclass that is an Avalon
component.</li>
</ul>
</section>
</body>
1.13 +1 -0 jakarta-commons-sandbox/vfs/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/project.properties,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- project.properties 20 Feb 2003 07:32:21 -0000 1.12
+++ project.properties 24 Feb 2003 07:32:40 -0000 1.13
@@ -7,6 +7,7 @@
maven.compile.deprecation = on
maven.javadoc.private = on
+maven.xdoc.date = left
#maven.linkcheck.enable = off
maven.jarResources.basedir=src/java
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
