Author: ecki
Date: Fri Jan 9 17:51:06 2015
New Revision: 1650613
URL: http://svn.apache.org/r1650613
Log:
Site: add 2.1 news, add Shell example documentation, inherit menu
Added:
commons/proper/vfs/trunk/examples/src/site/xdoc/
commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml
Modified:
commons/proper/vfs/trunk/core/src/site/site.xml
commons/proper/vfs/trunk/examples/src/site/site.xml
commons/proper/vfs/trunk/sandbox/src/site/site.xml
commons/proper/vfs/trunk/src/site/site.xml
commons/proper/vfs/trunk/src/site/xdoc/download.xml
commons/proper/vfs/trunk/src/site/xdoc/index.xml
Modified: commons/proper/vfs/trunk/core/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/site/site.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/site/site.xml (original)
+++ commons/proper/vfs/trunk/core/src/site/site.xml Fri Jan 9 17:51:06 2015
@@ -28,9 +28,7 @@
<item name="Commons VFS Home" href="../index.html"/>
</links>
- <menu name="Commons VFS">
- <item name="Overview" href="../index.html"/>
- </menu>
+ <!-- menus inherited -->
<menu ref="reports"/>
</body>
Modified: commons/proper/vfs/trunk/examples/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/examples/src/site/site.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/examples/src/site/site.xml (original)
+++ commons/proper/vfs/trunk/examples/src/site/site.xml Fri Jan 9 17:51:06 2015
@@ -28,9 +28,9 @@
<item name="Commons VFS Home" href="../index.html"/>
</links>
- <menu name="Commons VFS">
- <item name="Overview" href="../index.html"/>
- </menu>
+ <!-- menues are inherited -->
+
<menu ref="reports"/>
- </body>
+
+ </body>
</project>
Added: commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml?rev=1650613&view=auto
==============================================================================
--- commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml (added)
+++ commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml Fri Jan 9
17:51:06 2015
@@ -0,0 +1,92 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+ <properties>
+ <title>Apache Commons VFS Examples</title>
+ <author email="d...@commons.apache.org">Apache Commons
Developers</author>
+ </properties>
+
+ <body>
+
+ <section name="About Apache Commons VFS Examples">
+ <p>
+ This example module contains sample
+ <a href="xref/index.html">source code</a> for learning how to
use Apache
+ Commons VFS in the
<code>org.apache.commons.vfs2.example</code> package.
+ </p>
+ <p>
+ The <code>org.apache.commons.vfs2.libcheck</code> package
contains some Java
+ classes to exercise some of the functionality of the libraries
(dependencies)
+ used by Apache Commons VFS. This is mainly for the maintainers
of VFS providers.
+ </p>
+ </section>
+
+ <section name="Commons VFS Shell Example">
+
+ <p>
+ The Commons VFS Shell is an example for a command line shell.
+ It can be used to play with different providers and to verify
+ an installation.
+ </p>
+
+ <p>
+ Check out the page <a
href="https://wiki.apache.org/commons/VfsExampleShell";>VfsExampleShell</a>
+ on the Apache Commons Wiki for a number of examples. In
particular you can use the <code>info</code>
+ command to list the schemes which are auto discovered by the
<code>StandardFileSystemManager</code>.
+ </p>
+
+ <p>
+ The following examples assume an environment variable REP
which points to a populated local Maven
+ repository. As an alternative you can <a
href="../download.html">download</a> the required
+ <a href="../commons-vfs2/dependencies.html">dependencies</a>
manually. (The commons-collection4
+ dependency is not needed for the VFS Shell as it does not use
<code>LRUFilesCache</code>.) Because
+ of licensing restrictions the sandbox component must be
+ <a href="../commons-vfs2-sandbox/index.html">build locally</a>
and then installed into the repository.
+ </p>
+ </section>
+
+ <section name="VFS Shell (Linux)">
+<pre>REP=~/.m2/repositroy
+LIB=$REP/commons-logging/commons-logging/1.2/commons-logging-1.2.jar
+LIB=$LIB:$REP/commons-net/commons-net/2.2/commons-net-2.2.jar
+#
LIB=$LIB:$REP/org/apache/commons/commons-collections4/4.0/commons-collection-4.0.jar
+LIB=$LIB:$REP/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:%REP%/commons-codec/commons-codec/1.2/commons-codec-1.2.jar
+LIB=$LIB:$REP/com/jcraft/jsch/0.1.51/jsch-0.1.51.jar
+#
LIBS=$LIB:$REP/org/apache/commons/commons-vfs2-sandbox/2.1/commons-vfs2-sandbox-2.1.jar:$REP/jcifs/jcifs/0.8.3/jcifs-0.8.3.jar
+LIB=$LIB:$REP/org/apache/commons/commons-vfs2-examples/2.1/commons-vfs2-examples-2.1.jar
+LIB=$LIB:$REP/org/apache/commons/commons-vfs2/2.1/commons-vfs2-2.1.jar
+java -cp $LIB org.apache.commons.vfs2.example.Shell</pre>
+ </section>
+
+ <section name="VFS Shell (Windows)">
+<pre>set REP=%USERPROFILE\.m2\repository
+set LIB=%REP%\commons-logging\commons-logging\1.2\commons-logging-1.2.jar
+set LIB=%LIB%;%REP%\commons-net\commons-net\2.2\commons-net-2.2.jar
+rem # set
LIB=%LIB%;%REP%\org\apache\commons\commons-collections4\4.0\commons-collection-4.0.jar
+set
LIB=%LIB%;%REP%\commons-httpclient\commons-httpclient\3.1\commons-httpclient-3.1.jar;%REP%\commons-codec\commons-codec\1.2\commons-codec-1.2.jar
+set LIB=%LIB%;%REP%\com\jcraft\jsch\0.1.51\jsch-0.1.51.jar
+rem # set
LIBS=%LIB%:%REP%\org\apache\commons\commons-vfs2-sandbox\2.1\commons-vfs2-sandbox-2.1.jar:$REP\jcifs\jcifs\0.8.3\jcifs-0.8.3.jar
+set
LIB=%LIB%:%REP%\org\apache\commons\commons-vfs2-examples\2.1\commons-vfs2-examples-2.1.jar
+set LIB=%LIB%:%REP%\org\apache\commons\commons-vfs2\2.1\commons-vfs2-2.1.jar
+java -cp %LIB% org.apache.commons.vfs2.example.Shell</pre>
+ </section>
+
+ </body>
+</document>
+
Modified: commons/proper/vfs/trunk/sandbox/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/sandbox/src/site/site.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/sandbox/src/site/site.xml (original)
+++ commons/proper/vfs/trunk/sandbox/src/site/site.xml Fri Jan 9 17:51:06 2015
@@ -28,9 +28,7 @@
<item name="Commons VFS Home" href="../index.html"/>
</links>
- <menu name="Commons VFS">
- <item name="Overview" href="../index.html"/>
- </menu>
+ <!-- menu inherited -->
<menu ref="reports"/>
</body>
Modified: commons/proper/vfs/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/site/site.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/site/site.xml (original)
+++ commons/proper/vfs/trunk/src/site/site.xml Fri Jan 9 17:51:06 2015
@@ -25,7 +25,7 @@
<body>
- <menu name="Commons VFS">
+ <menu name="Commons VFS" inherit="top">
<item name="Overview" href="/index.html"/>
<item name="Download and Build" href="/download.html"/>
<item name="Using the API" href="/api.html"/>
@@ -35,14 +35,14 @@
<item name="Wiki"
href="http://wiki.apache.org/commons/VFS"/>
</menu>
- <menu name="Development">
+ <menu name="VFS Development" inherit="top">
<item name="Testing" href="/testing.html"/>
<item name="Mailing Lists" href="/mail-lists.html"/>
<item name="Issue Tracking" href="/issue-tracking.html"/>
<item name="Source Repository" href="/source-repository.html"/>
</menu>
- <menu name="VFS Components">
+ <menu name="VFS Components" inherit="top">
<item name="Core" href="commons-vfs2/index.html"/>
<item name="Examples" href="commons-vfs2-examples/index.html"/>
<item name="Sandbox" href="commons-vfs2-sandbox/index.html"/>
Modified: commons/proper/vfs/trunk/src/site/xdoc/download.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/site/xdoc/download.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/site/xdoc/download.xml (original)
+++ commons/proper/vfs/trunk/src/site/xdoc/download.xml Fri Jan 9 17:51:06 2015
@@ -39,42 +39,43 @@
<tr>
<td>
<a href="http://commons.apache.org/logging/";>Commons
Logging</a>
- Version 1.1.1 or later.
+ Version 1.2.
</td>
<td>All</td>
</tr>
<tr>
<td>
<a
href="http://commons.apache.org/collections/";>Commons Collections</a>
- Version 3.1
+ Version 4.0 or later
</td>
<td>LRU Cache (optional)</td>
</tr>
<tr>
<td>
<a href="http://commons.apache.org/compress/";>Commons
Compress</a>
- Version 1.6
+ Version 1.9 or later
</td>
<td>TAR, Bzip2</td>
</tr>
<tr>
<td>
<a href="http://commons.apache.org/net/";>Commons
Net</a>
- Version 2.0 or later.
+ Version 3.3 or later.
</td>
<td>FTP</td>
</tr>
<tr>
<td>
<a
href="http://commons.apache.org/httpclient/";>Commons Httpclient</a>
- Version 3.0.
+ Version 3.1.<br/>
+ Requires <a
href="http://commons.apache.org/proper/commons-codec/";>Commons Codec</a>
Version 1.2
</td>
<td>WebDAV, HTTP, URI Utils</td>
</tr>
<tr>
<td>
- <a href="http://jackrabbit.apache.org";>Apache
Jackrabbit</a>
- Version 1.5.2 or later
+ <a href="http://jackrabbit.apache.org";>Apache
Jackrabbit WebDAV</a>
+ Version 1.6.5 or later
</td>
<td>WebDAV</td>
</tr>
@@ -88,14 +89,14 @@
<tr>
<td>
<a href="http://www.jcraft.com/jsch/";>JSch</a>
- Version 0.1.42 or later.
+ Version 0.1.51 or later.
</td>
<td>SFTP</td>
</tr>
<tr>
<td>
<a
href="http://java.sun.com/products/javamail/";>javamail</a>
- Version 1.4
+ Version 1.4.7.
</td>
<td>mime (VFS sandbox)</td>
</tr>
@@ -139,12 +140,11 @@
<code>commons-vfs/core/target/commons-vfs2-<version>.jar</code>.
</p><p>
If you want to build the additional sandbox file systems as
well, use
- <code>mvn -P include-sandbox clean veriy</code>. This will
also create the sandbox
+ <code>mvn -Pinclude-sandbox clean verify</code>. This will
also create the sandbox
components in
<code>commons-vfs/sandbox/target/commons-vfs2-sandbox-<version>.jar</code>.
</p><p>
- With the following command you can run the simple
<code>Shell</code> example:<br/>
- <br/>
- <code>java -cp
core/target/commons-vfs2-2.0.jar:examples/target/commons-vfs2-examples-2.0.jat</code>
+ See the <a
href="commons-vfs2-example/index.html">commons-vfs2-example</a> Module on how
+ to use VFS Example Shell to verify the result.
</p>
</section>
</body>
Modified: commons/proper/vfs/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/site/xdoc/index.xml?rev=1650613&r1=1650612&r2=1650613&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/vfs/trunk/src/site/xdoc/index.xml Fri Jan 9 17:51:06 2015
@@ -19,7 +19,7 @@
<document>
<properties>
<title>Commons Virtual File System</title>
- <author email="jstrac...@apache.org">James Strachan</author>
+ <author email="d...@commons.apache.org">Apache Commons
Developers</author>
</properties>
<body>
@@ -45,7 +45,7 @@
<li>
Caching of file information. Caches information in-JVM,
and optionally can cache remote file information on the
- local file system.
+ local file system (replicator).
</li>
<li>Event delivery.</li>
<li>
@@ -66,15 +66,26 @@
<section name="Requirements">
<p>
- Commons VFS 2.0 requires Java 5. Many of the file systems require
that optional components be present
+ Apache Commons VFS 2.1 requires Java 6. Many of the file systems
require that optional components be present
in order for the protocol to be enabled. See the <a
href="download.html">download and build</a> page for
information on the optional dependencies.
</p>
+ <p>
+ Apache Commons VFS 2.0 can be used in a Java 5 runtime.
+ </p>
</section>
<section name="News">
<p>
- Commons VFS 2.0 is now available. Support for FTPS and WebDav have
been added in addition to many bugs
+ Apache Commons VFS 2.1 is a bugfix release to VFS 2.0. IF you meet
the requirements you should be able
+ to replace 2.0 with 2.1 without the need for changes to API
consumers. VFS 2.1 has introduced some now
+ methods for provider interfaces (like <code>FileObject</code>). If
you implement a VFS provider and use the
+ corresponding <code>Abstract*</code> or <code>Default*</code>
classes, there should be no need to modify
+ the code or recompile the provider.
+ See the <a
href="https://archive.apache.org/dist/commons/vfs/RELEASE_NOTES.txt";>Release
Notes</a> and the
+ <a href="commons-vfs2/clirr-report.html">Clirr Report</a> for
details.
+ </p><p>
+ Apache Commons VFS 2.0 adds support for FTPS and WebDav have been
added in addition to many bugs
being fixed. Version 2.0 is not binary compatible with version
1.0. To insure that both 1.0 and 2.0 can
coexist version 2.0 has had its Maven groupId changed to
org.apache.commons, its Maven artifact changed
to commons-vfs2, and the package names are now
org.apache.commons.vfs2. The API changes are fairly minor
