commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From adammurd...@apache.org
Subject cvs commit: jakarta-commons-sandbox/vfs/xdocs download.xml filesystems.xml todo.xml
Date Thu, 20 Feb 2003 07:33:54 GMT
adammurdoch    2003/02/19 23:33:54

  Modified:    vfs/xdocs download.xml filesystems.xml todo.xml
  Log:
  Docs for the SFTP provider.
  
  Revision  Changes    Path
  1.6       +9 -10     jakarta-commons-sandbox/vfs/xdocs/download.xml
  
  Index: download.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/download.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- download.xml	15 Feb 2003 02:36:50 -0000	1.5
  +++ download.xml	20 Feb 2003 07:33:54 -0000	1.6
  @@ -34,9 +34,7 @@
                           <a href="http://jakarta.apache.org/commons/net/">Commons
Net</a>.
                           You will need to use a recent snapshot.
                       </td>
  -                    <td>
  -                        FTP file system.
  -                    </td>
  +                    <td>FTP</td>
                   </tr>
                   <tr>
                       <td>
  @@ -44,9 +42,7 @@
                           <a href="http://jakarta.apache.org/commons/httpclient/">Commons
Httpclient</a>.
                           Version 2.0 alpha 2 or later.
                       </td>
  -                    <td>
  -                        WebDAV file system.
  -                    </td>
  +                    <td>WebDAV</td>
                   </tr>
                   <tr>
                       <td>
  @@ -55,17 +51,20 @@
                           You will need <code>webdavlib.jar</code> from a recent
                           snapshot.
                       </td>
  -                    <td>
  -                        WebDAV file system.
  -                    </td>
  +                    <td>WebDAV</td>
                   </tr>
                   <tr>
                       <td>
                           <a href="http://jcifs.samba.org/">jCIFS</a> Version
0.7.0 b5 or later.
                       </td>
  +                    <td>CIFS</td>
  +                </tr>
  +                <tr>
                       <td>
  -                        CIFS file system.
  +                        <a href="http://www.jcraft.com/jsch/">JSch</a> Version
0.1.0 or later.
  +                        Note that JSch requires Java 1.4 or later.
                       </td>
  +                    <td>SFTP</td>
                   </tr>
               </table>
           </section>
  
  
  
  1.6       +45 -8     jakarta-commons-sandbox/vfs/xdocs/filesystems.xml
  
  Index: filesystems.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/filesystems.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- filesystems.xml	17 Feb 2003 08:57:43 -0000	1.5
  +++ filesystems.xml	20 Feb 2003 07:33:54 -0000	1.6
  @@ -9,13 +9,30 @@
           <section name="Supported File Systems">
               <p>Commons VFS currently supports the following file systems:</p>
               <ul>
  -                <li><a href="#Local Files">Local Files</a></li>
  -                <li><a href="#Zip and Jar Files">Zip and Jar Files</a></li>
  -                <li><a href="#HTTP and HTTPS">HTTP and HTTPS</a></li>
  -                <li><a href="#WebDAV">WebDAV</a></li>
  -                <li><a href="#FTP">FTP</a></li>
  -                <li><a href="#CIFS">SMB and CIFS</a></li>
  -                <li><a href="#Temporary Files">Temporary Files</a></li>
  +                <li>
  +                    <a href="#FTP">FTP</a>
  +                </li>
  +                <li>
  +                    <a href="#Local Files">Local Files</a>
  +                </li>
  +                <li>
  +                    <a href="#HTTP and HTTPS">HTTP and HTTPS</a>
  +                </li>
  +                <li>
  +                    <a href="#CIFS">CIFS</a>
  +                </li>
  +                <li>
  +                    <a href="#SFTP">SFTP</a>
  +                </li>
  +                <li>
  +                    <a href="#Temporary Files">Temporary Files</a>
  +                </li>
  +                <li>
  +                    <a href="#WebDAV">WebDAV</a>
  +                </li>
  +                <li>
  +                    <a href="#Zip and Jar">Zip and Jar</a>
  +                </li>
               </ul>
           </section>
   
  @@ -44,7 +61,7 @@
               </ul>
           </section>
   
  -        <section name="Zip and Jar Files">
  +        <section name="Zip and Jar">
   
               <p>Provides read-only access to the contents of Zip and Jar files.</p>
   
  @@ -109,6 +126,26 @@
               <p><b>Examples</b></p>
               <ul>
                   <li><code>ftp://mypassword:myusername@somehost/pub/downloads/somefile.tgz</code></li>
  +            </ul>
  +
  +        </section>
  +
  +        <section name="SFTP">
  +
  +            <p>
  +                Provides access to the files on an SFTP server (that is, an SSH
  +                or SCP server).
  +            </p>
  +
  +            <p><b>URI Format</b></p>
  +
  +            <p><code>sftp://[[<i>password</i>:]<i>username</i>@]<i>hostname</i>[:<i>port</i>][<i>absolute-path</i>]</code></p>
  +
  +            <p><b>Examples</b></p>
  +            <ul>
  +                <li>
  +                    <code>sftp://mypassword:myusername@somehost/pub/downloads/somefile.tgz</code>
  +                </li>
               </ul>
   
           </section>
  
  
  
  1.6       +32 -15    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.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- todo.xml	14 Feb 2003 23:48:08 -0000	1.5
  +++ todo.xml	20 Feb 2003 07:33:54 -0000	1.6
  @@ -19,7 +19,6 @@
                   <li>Fix all the todo items in the code.</li>
                   <li>Add more providers:
                       <ul>
  -                        <li>http and webdav</li>
                           <li>nfs</li>
                           <li>tar</li>
                           <li>gzip</li>
  @@ -27,15 +26,36 @@
                           <li>ClassLoader resources</li>
                           <li>cvs</li>
                           <li>subversion</li>
  -                        <li>scp</li>
                           <li>jdbc filesystem</li>
                           <li>xml filesystem</li>
                           <li>jndi</li>
                           <li>imap</li>
  +                        <li>local mirror</li>
                           <li>...</li>
                       </ul>
                   </li>
                   <li>Formalise the provider API.</li>
  +                <li>WebDAV Provider:
  +                    <ul>
  +                        <li>Add plain http support, and auto-detect dav resources.</li>
  +                    </ul>
  +                </li>
  +                <li>SFTP Provider:
  +                    <ul>
  +                        <li>Add key-based authentication.</li>
  +                    </ul>
  +                </li>
  +                <li>Zip/Jar Provider:
  +                    <ul>
  +                        <li>Extract an AbstractLayerFileSystem out of ZipFileSystem.</li>
  +                        <li>
  +                            Track changes to the parent layer.  Eg when the
  +                            parent layer is deleted, mark all the files in the
  +                            fs as 'does-not-exist'.
  +                        </li>
  +                        <li>Add support for writing to zip/jar files.</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,
  @@ -46,15 +66,10 @@
                       to check last-modified time.  Replicator needs to be more
                       configurable.</li>
                   <li>Add persistent replicator.</li>
  -                <li>Add local mirroring.</li>
  -                <li>Extract AbstractLayerFileSystem out of ZipFileSystem.</li>
                   <li>
  -                    Change AbstractLayeredFileSystem to track changes to
  -                    the parent layer.  Eg when the parent layer is deleted,
  -                    mark all the files in the fs as 'does-not-exist'.</li>
  -                <li>Change AbstractLayeredFileSystem to support writeable
  -                    layered fs.</li>
  -                <li>Make StandardFileSystemManager configurable from an XML descriptor.</li>
  +                    Make StandardFileSystemManager configurable from an XML
  +                    descriptor or properties file.
  +                </li>
                   <li>Change the model so that folders may have content.</li>
                   <li>
                       Finish support for junctions:  Make ancestors of a junction
  @@ -66,7 +81,8 @@
                       of a Jar file).</li>
                   <li>
                       Add Filtering file systems, which sit on top of another
  -                    file system, and alter the contents.  For example, gzip or bzip2.</li>
  +                    file system, and alter the contents.  For example, gzip or bzip2.
  +                </li>
                   <li>Add an equivalent of the fileScanner Jelly tag.</li>
                   <li>
                       Add an equivalent of Ant path, fileset, dirset, filelist, etc.
  @@ -75,7 +91,7 @@
                   <li>
                       Allow selectors, name mappers, and filters to be specified
                       for the Ant tasks.</li>
  -                <li>Capabilities discovery.</li>
  +                <li>Finish capabilities discovery.</li>
                   <li>Attributes and attribute schema.</li>
                   <li>
                       Handle file canonicalisation better (for cases like
  @@ -87,9 +103,10 @@
                   <li>Sort out threading model.</li>
                   <li>Add a file monitor, that watches for external changes to files.</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.
  +                    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>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message