You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ra...@apache.org on 2010/09/23 08:04:34 UTC
svn commit: r1000332 [26/27] - in
/synapse/branches/commons-vfs-2-synapse-2.0: ./ core/ core/src/
core/src/main/ core/src/main/java/ core/src/main/java/org/
core/src/main/java/org/apache/ core/src/main/java/org/apache/commons/
core/src/main/java/org/ap...
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/changes/changes.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/changes/changes.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/changes/changes.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,67 @@
+<?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>Changes</title>
+ <author email="rgoers@apache.org">Ralph Goers</author>
+ </properties>
+
+ <body>
+ <release version="2.0" date="in SVN" description="">
+ <action dev="rgoers" type="fix" issue="VFS-227" due-to="Sergey Vladimirov">
+ InputStream and RandomAccessContent memory leak in FileContentThreadData
+ </action>
+ <action dev="rgoers" type="update" issue="VFS-263" due-to="Ingo Maas">
+ WebdavFileObject does not implement doSetAttribute()
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-259" due-to="Marek Zawirski">
+ Http and Webdav FIleContentInfoFactory: undress to AbstractFileObject before casting
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-261" due-to="Simon Olofsson">
+ WebDAV upload corrupts binary files
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-276" due-to="Vince Bonfanti">
+ add ProviderTestConfig.getDefaultFileSystemManager() method
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-282" due-to="Alexey">
+ SftpFileProvider and SftpFileSystemConfigBuilder can't change ssh authentication methods
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-269" due-to="Marek Zawirski">
+ HttpFileObject: unsupported content over 2GB length
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-287" due-to="Mircea-Eugen Ionica">
+ LocalFileName objects are not released from AbstractFileSystem.listenerMap when all listeners are removed.
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-216" due-to="Reetu Mutti">
+ The FTP Configuration includes an option to set a timeout for the data connection, but not for the socket
+ timeout. This is a problem, as idle sockets can cause your download to hang forever and never timeout.
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-289" due-to="Kirill Safonov">
+ FTP connection is not released If exception is thrown out of FtpFileObject.doGetOutputStream().
+ </action>
+ <action dev="rgoers" type="fix" issue="VFS-286" due-to="Kirill Safonov">
+ SftpFileObject.doListChildrenResolved() changes the working dir before doing ChannelSftp.ls() call.
+ If ls() throws an exception, the current directory is not reset. All the subsequent operations that rely on the
+ current dir will fail trying to change into nonexistent directory.
+ </action>
+ <action dev="rgoers" type="add" issue="VFS-244">
+ Rename HttpRandomAccesContent to HttpRandomAccessContent.
+ </action>
+ </release>
+ </body>
+</document>
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.png
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.png?rev=1000332&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.xcf
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.xcf?rev=1000332&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/commons-vfs-2-synapse-2.0/src/site/resources/images/vfs-logo-white.xcf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/site.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/site.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/site.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/site.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ 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.
+-->
+<project name="Commons VFS">
+
+ <bannerRight>
+ <name>Commons VFS</name>
+ <src>/images/vfs-logo-white.png</src>
+ <href>/index.html</href>
+ </bannerRight>
+
+ <body>
+
+ <menu name="Commons VFS">
+ <item name="Overview" href="/index.html"/>
+ <item name="Download and Build" href="/download.html"/>
+ <item name="3rd party plugins" href="/3rdparty.html"/>
+ <item name="Using the API" href="/api.html"/>
+ <item name="API JavaDocs" href="/apidocs/index.html"/>
+ <item name="File Systems" href="/filesystems.html"/>
+ <item name="Ant Tasks" href="/anttasks.html"/>
+ <item name="Wiki" href="http://wiki.apache.org/commons/VFS"/>
+ </menu>
+
+ <menu name="Development">
+ <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"/>
+ <item name="To Do List" href="/todo.html"/>
+ </menu>
+
+ <menu name="Components">
+ <item name="Core" href="commons-vfs/index.html"/>
+ <item name="Examples" href="commons-vfs-examples/index.html"/>
+ <item name="Sandbox" href="commons-vfs-sandbox/index.html"/>
+ </menu>
+ </body>
+
+</project>
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/3rdparty.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/3rdparty.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/3rdparty.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/3rdparty.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,44 @@
+<?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>3rd party plugins</title>
+ <author email="imario@apache.org">Mario Ivankovits</author>
+ </properties>
+
+ <body>
+ <section name="External plugins">
+
+ <p>
+ Commons VFS provides a way to extend it by simply placing plugin-jars
+ into the classpath.
+ </p>
+
+ <p>Some external plugins:</p>
+ <ul>
+ <li>ISO 9660 - <a href="http://loopy.sourceforge.net">http://loopy.sourceforge.net</a><br/>
+ Reads .iso files
+ </li>
+ </ul>
+
+ </section>
+
+ </body>
+</document>
+
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/anttasks.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/anttasks.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/anttasks.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/anttasks.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,292 @@
+<!--
+ 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>Ant Tasks</title>
+ <author email="adammurdoch@apache.org">Adam Murdoch</author>
+ </properties>
+
+ <body>
+ <section name="Ant Tasks">
+ <p>
+ Commons VFS includes several Ant tasks that can be used
+ to create, delete, copy and move files of any supported type.
+ The tasks are:
+ </p>
+ <ul>
+ <li>
+ <a href="#V-Copy">
+ <code><v-copy></code>
+ </a>
+ .
+ Copies a set of source folders and files to a destination
+ folder.
+ </li>
+ <li>
+ <a href="#V-Delete">
+ <code><v-delete></code>
+ </a>
+ .
+ Deletes a file or folder.
+ </li>
+ <li>
+ <a href="#V-Mkdir">
+ <code><v-mkdir></code>
+ </a>
+ .
+ Creates a folder.
+ </li>
+ <li>
+ <a href="#V-Move">
+ <code><v-move></code>
+ </a>
+ .
+ Moves a set of source folders and files to a destination
+ folder.
+ </li>
+ <li>
+ <a href="#V-Sync">
+ <code><v-sync></code>
+ </a>
+ .
+ Synchronises a destination folder with a set of source
+ folder and files.
+ </li>
+ </ul>
+ <p>
+ All file name attributes support relative and absolute local
+ file names, and
+ <a href="filesystems.html">absolute URI</a>
+ .
+ File names are interpreted relative to the Ant project's base
+ directory.
+ </p>
+
+ <subsection name="Using the Tasks">
+ <p>
+ To use the Ant tasks, copy commons-vfs.jar and its
+ dependencies into the
+ <code>$ANT_HOME/lib</code>
+ directory,
+ and use the following in your Ant scipt to define the tasks:
+ </p>
+
+ <source><![CDATA[
+<taskdef resource="org/apache/commons/vfs/tasks/tasks.properties"/>
+ ]]></source>
+
+ <p>
+ Alternatively, you can provide an explicit classpath when
+ you define the tasks:
+ </p>
+
+ <source><![CDATA[
+<taskdef resource="org/apache/commons/vfs/tasks/tasks.properties">
+ <classpath> ... </classpath>
+</taskdef>
+ ]]></source>
+
+ <p>
+ You can also use antlib:
+ <br/>
+ <b>Notice: VFS tasks registered that way do not have te "v-" prefix.</b>
+ If you migrate to antlib simply replace "v-" by e.g. "vfs:" or whatever
+ namespace you use.
+ </p>
+
+ <source><![CDATA[
+<project ... xmlns:vfs="antlib:org.apache.commons.vfs.tasks">
+ <target name="dosomething">
+ <vfs:copy .../>
+ </target>
+</project>
+ ]]></source>
+
+ </subsection>
+ </section>
+
+ <section name="V-Copy">
+ <p>Copies a set of files to a destination folder. Does not copy
+ source files where the destination file exists and is newer than
+ the source file. The copy task takes the following attributes:</p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>destdir</td>
+ <td>The destination folder. This folder is created if it
+ does not exist.</td>
+ <td rowspan="2">One only</td>
+ </tr>
+ <tr>
+ <td>destfile</td>
+ <td>The destination file. Can only be used if there is a
+ single source file.</td>
+ </tr>
+ <tr>
+ <td>srcdir</td>
+ <td>The source folder. If used the includes and desdir
+ attributes should be specified.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>includes</td>
+ <td>A comma or space separated list of files. The files
+ are resolved in combination with the specified
+ srcdir attribute.</td>
+ <td>Only if srcdir is specified.</td>
+ </tr>
+ <tr>
+ <td>overwrite</td>
+ <td>Always copy files, ignoring the last-modified time of
+ the destination file.</td>
+ <td>No, default is
+ <code>false</code>
+ .
+ </td>
+ </tr>
+ <tr>
+ <td>preservelastmodified</td>
+ <td>Set the last-modified time of destination files to
+ the same value as the source files. May not be supported
+ by the destination file system.</td>
+ <td>No, default is
+ <code>true</code>
+ .
+ </td>
+ </tr>
+ <tr>
+ <td>srcdirisbase</td>
+ <td>Set whether the source directory should be used as base directory.
+ If set to true, the subdirectories of the specified directories will be copied as well.</td>
+ <td>No, default is
+ <code>false</code>
+ .
+ </td>
+ </tr>
+ <tr>
+ <td>src</td>
+ <td>A source file or folder to copy. Copies all descendents
+ of a folder.</td>
+ <td>No</td>
+ </tr>
+ </table>
+
+ <subsection name="Nested Elements">
+ <p>
+ <b>
+ <code><src></code>
+ </b>
+ </p>
+
+ <p>Defines a source file or folder to copy. It takes the
+ following attributes:</p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>file</td>
+ <td>The source file.</td>
+ <td>Yes</td>
+ </tr>
+ </table>
+ </subsection>
+
+ </section>
+
+ <section name="V-Move">
+ <p>Moves a set of files to a destination folder. Has the same
+ attributes and elements as the copy task and following attributes:</p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>tryRename</td>
+ <td>The destination folder. This folder is created if it
+ does not exist.</td>
+ <td>No, default is
+ <code>false</code>
+ </td>
+ </tr>
+ </table>
+ </section>
+
+ <section name="V-Sync">
+ <p>Synchronises a destination folder with a set of source files.
+ Has the same attributes and elements as the copy task.</p>
+ </section>
+
+ <section name="V-Delete">
+ <p>Deletes a file or folder. It takes the following attributes:</p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>file</td>
+ <td>The file or folder to delete. All descendents of
+ the folder are deleted.</td>
+ <td rowspan="2">One only</td>
+ </tr>
+ <tr>
+ <td>srcdir</td>
+ <td>The source folder. If used the includes attribute
+ should be specified.</td>
+ </tr>
+ <tr>
+ <td>includes</td>
+ <td>A comma or space separated list of files. The files
+ are resolved in combination with the specified
+ srcdir attribute.</td>
+ <td>Only if srcdir is specified.</td>
+ </tr>
+ </table>
+ </section>
+
+ <section name="V-Mkdir">
+ <p>Creates a folder. It takes the following attributes:</p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>dir</td>
+ <td>The folder create.</td>
+ <td>Yes</td>
+ </tr>
+ </table>
+
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/api.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/api.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/api.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/api.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,379 @@
+<!--
+ 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>Using The API</title>
+ <author email="adammurdoch@apache.org">Adam Murdoch</author>
+ </properties>
+
+ <body>
+ <section name="Using The API">
+ <p>
+ The
+ <a href="apidocs/org/apache/commons/vfs/FileSystemManager.html">FileSystemManager</a>
+ interface provides access to Commons VFS. Using this interface
+ you can locate files and create file systems.
+ There are a
+ <a href="#Configuring Commons VFS">number of ways</a>
+ to obtain a
+ <code>FileSystemManager</code> instance.
+ The simplest is to use the static
+ <a href="apidocs/org/apache/commons/vfs/VFS.html#getManager()">VFS.getManager()</a>
+ method, which returns the default Commons VFS implementation.
+ </p>
+
+ <p>
+ Once you have a
+ <code>FileSystemManager</code>, you can use its
+ <code>resolveFile()</code> methods to locate a file by name.
+ For example:
+ </p>
+
+ <source><![CDATA[
+FileSystemManager fsManager = VFS.getManager();
+FileObject jarFile = fsManager.resolveFile( "jar:lib/aJarFile.jar" );
+ ]]></source>
+
+ <p>
+ Each file is represented by a
+ <a href="apidocs/org/apache/commons/vfs/FileObject.html">FileObject</a>
+ instance. Using this interface you can create or delete the
+ file, list its children, read or write its content, and so on.
+ For example:
+ </p>
+
+ <source><![CDATA[
+// Locate the Jar file
+FileSystemManager fsManager = VFS.getManager();
+FileObject jarFile = fsManager.resolveFile( "jar:lib/aJarFile.jar" );
+
+// List the children of the Jar file
+FileObject[] children = jarFile.getChildren();
+System.out.println( "Children of " + jarFile.getName().getURI() );
+for ( int i = 0; i < children.length; i++ )
+{
+ System.out.println( children[ i ].getName().getBaseName() );
+}
+ ]]></source>
+
+ <p>
+ In some cases you might want to explicitely free resources allocated by the filesystem.
+ You can do this by calling
+ <a href="apidocs/org/apache/commons/vfs/FileSystemManager.html#closeFileSystem">VFS.getManager().closeFileSystem(fs)</a>.
+ If you use VFS as singleton (as described above) you should take care that this will close the filesystem for
+ all threads.<br />
+ In other words, do not close any globally used filesystem like the one for local files.
+ </p>
+
+ <p>
+ See the
+ <a href="apidocs/org/apache/commons/vfs/FileObject.html">FileObject</a>
+ Javadocs for more detail.
+ </p>
+
+ <subsection name="Cache">
+ <p>
+ Commons VFS uses a <a href="apidocs/org/apache/commons/vfs/cache/SoftRefFilesCache.html">SoftRefFilesCache</a> to release memory if a file is no longer used by the application.
+ </p>
+ <p>
+ This cache will return the same instance for a file as long as it is "strongly reachable" e.g. you
+ hold a reference to this object. If the FileObject is no longer reachable, and the jvm needs some memory,
+ it will be released.
+ </p>
+ <p>
+ There is also a internal cache of each file object avoid the need to access the network layer. Now its possible
+ to configure this behviour through the use of <a href="apidocs/org/apache/commons/vfs/CacheStrategy.html">CacheStrategy</a>.
+ <br />
+ Do this on the DefaultFileSystemManager. For example:
+ <code>
+ ((DefaultFileSystemManager) VFS.getManager()).setCacheStrategy(CacheStrategy.ON_CALL)
+ </code>
+ </p>
+ </subsection>
+
+ <subsection name="User Authentication">
+ <p>
+ You can put the credentials into the url, but the drawback here is, that it is
+ easily possible to get access to the password.
+ </p>
+ <p>
+ To solve you can use the
+ <a href="apidocs/org/apache/commons/vfs/UserAuthenticator.html">UserAuthenticator</a>
+ </p>
+ <p>
+ For example:
+ <code>
+ StaticUserAuthenticator auth = new StaticUserAuthenticator("username", "password", null);
+ FileSystemOptions opts = new FileSystemOptions();
+ DefaultFileSystemConfigBuilder.getInstance().setUserAuthenticator(opts, auth);
+
+ FileObject fo = VFS.getManager().resolveFile("smb://host/anyshare/dir", opts);
+ </code>
+ </p>
+ <p>
+ Internally the UserAuthenticator uses char arrays which will be zeroed before it is
+ freed for garbage collection.Unhappily none of the current libraries use char
+ arrays and so VFS has to create a string. Thus, the main advantage
+ of this solution - security - is lost, but hey, thats not VFS fault ;-)
+ </p>
+ <p>
+ VFS calls <code>UserAuthenticator.requestAuthentication</code> each time it
+ requires credentials, it depends on the filesystem implementation how often
+ this might be. For example, with FTP this is on every connection, in SMB/JCIFS
+ this is for EVERY OBJECT. It is up to you how long you will cache credentials
+ of if you would like to provide a "save credentials" checkbox.
+ </p>
+ </subsection>
+
+ <subsection name="Examples">
+ <p>
+ For an example of using the API, take a look at the classes
+ in the
+ <a href="apidocs/org/apache/commons/vfs/example/package-summary.html">example</a>
+ package.
+ </p>
+ </subsection>
+
+ </section>
+
+ <section name="Configuring Commons VFS">
+ <p>
+ Commons VFS is represented using the
+ <a href="apidocs/org/apache/commons/vfs/FileSystemManager.html">FileSystemManager</a>
+ interface. There are a number of ways to create and configure a
+ <code>FileSystemManager</code> instance.
+ </p>
+ <p>
+ The simplest method is to use the static
+ <a href="apidocs/org/apache/commons/vfs/VFS.html#getManager()">VFS.getManager()</a>
+ method, which returns the default Commons VFS implementation.
+ </p>
+ <p>
+ This method will also automatically scan the classpath for a /META-INF/vfs-providers.xml file
+ (also in jar files).
+ If such a file is found Commons VFS uses it in <u>addition</u> to the default providers.xml.
+ This allows you to start using a new filesystem by simply drop its implementation into the classpath.
+ The configuration file format is described below.<br />
+ <b>Notice:</b> Currently it is not allowed to override a already configured filesystem. Commons VFS throws
+ an exception if there is already a filesystem for a scheme.
+ </p>
+
+ <p>
+ To configure Commons VFS programatically, you can create an
+ instance of
+ <a href="apidocs/org/apache/commons/vfs/impl/DefaultFileSystemManager.html">DefaultFileSystemManager</a>
+ and configure it manually. The default constructor
+ <code>DefaultFileSystemManager</code> creates a manager that
+ is completely empty. You will have to add file providers to it
+ to make it do anything useful.
+ </p>
+ <p>
+ Here are the steps for using
+ <code>DefaultFileSystemManager</code>:
+ </p>
+ <ol>
+ <li>Create a new instance.</li>
+ <li>
+ Set the logger for the manager and all its components,
+ using
+ <code>setLogger()</code>. This step is
+ optional, and if skipped, the manager will use the default
+ logger provided by Commons Logging.
+ </li>
+ <li>
+ Add file providers, using
+ <code>addProvider()</code>.
+ </li>
+ <li>
+ Set the default provider, using
+ <code>setDefaultProvider()</code>. This step is optional.
+ See
+ <a href="apidocs/org/apache/commons/vfs/provider/url/UrlFileProvider.html">UrlFileProvider</a>
+ for a useful default provider.
+ </li>
+ <li>
+ Set the file replicator, using
+ <code>setReplicator()</code>.
+ This step is optional.
+ </li>
+ <li>
+ Set the temporary file store, using
+ <code>setTemporaryFileStore()</code>.
+ This step is optional.
+ </li>
+ <li>
+ Set the base file using
+ <code>setBaseFile()</code>. The
+ base file is used to resolve relative URI passed to
+ <code>resolveFile()</code>. This step is optional.
+ </li>
+ <li>
+ Initialise the manager using
+ <code>init()</code>.
+ </li>
+ </ol>
+ <p>
+ You should make sure that you call
+ <code>close()</code> on the
+ manager when you are finished with it.
+ </p>
+
+ <p>
+ The third method for configuring Commons VFS, is to configure
+ it from a file. Create an instance of
+ <a href="apidocs/org/apache/commons/vfs/impl/StandardFileSystemManager.html">StandardFileSystemManager</a>,
+ and use its
+ <code>setConfiguration()</code> method to set the
+ location of the configuration file to use. The configuration
+ file format is described below.
+ </p>
+
+ <p>
+ <code>StandardFileSystemManager</code> is a subclass of
+ <code>DefaultFileSystemManager</code>, so you can also
+ configure it programmatically, as described above.
+ </p>
+ <subsection name="Configuration File">
+ <p>
+ 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:
+ </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,
+ which specifies the fully-qualified name of the provider
+ class. The provider class must be public, and must have a
+ public constructor with an FileSystemManager argument which
+ allows the systems to pass the used filesystem manager.
+ </p>
+ <p>
+ The
+ <code><provider></code> element may contain
+ zero or more
+ <code><scheme></code> elements,
+ and zero or more
+ <code><if-available></code> elements.
+ </p>
+ <p>
+ The
+ <code><scheme></code> element defines a URI scheme
+ that the provider will handle. It must have a
+ <code>name</code> attribute, which specifies the URI scheme.
+ </p>
+ <p>
+ The
+ <code><if-available></code> elements is used to
+ disable the provider if certain classes are not present in
+ the class-path.
+ It must have a
+ <code>class-name</code> attribute, which
+ 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>
+ <source><![CDATA[
+<providers>
+ <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"/>
+ </provider>
+ <default-provider class-name="org.apache.commons.vfs.provider.url.UrlFileProvider"/>
+</providers>
+ ]]></source>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,139 @@
+<!--
+ 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>Download</title>
+ <author email="adammurdoch@apache.org">Adam Murdoch</author>
+ </properties>
+
+ <body>
+ <section name="Download">
+ <p>
+ The latest release of Commons VFS can be found
+ <a href="http://commons.apache.org/downloads/download_vfs.cgi">here</a>
+ .
+ </p>
+ <p>
+ You will also need to download the jars used by Commons VFS.
+ These are listed below:
+ </p>
+ <table>
+ <tr>
+ <th>Dependency</th>
+ <th>Required For</th>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://commons.apache.org/logging/">Commons Logging</a>
+ Version 1.1.1 or later.
+ </td>
+ <td>All</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://commons.apache.org/collections/">Commons Collections</a>
+ Version 3.1
+ </td>
+ <td>LRU Cache (optional)</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://commons.apache.org/net/">Commons Net</a>
+ Version 1.4.1 or later.
+ </td>
+ <td rowspan="2">FTP</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://commons.apache.org/httpclient/">Commons Httpclient</a>
+ .
+ Version 2.0.
+ </td>
+ <td>
+ WebDAV
+ <br/>
+ HTTP, URI Utils
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://jackrabbit.apache.org">Apache Jackrabbit</a>
+ Version 1.5.2 or later
+ </td>
+ <td>WebDAV</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://jcifs.samba.org/">jCIFS</a>
+ Version 0.8.3 or later.
+ </td>
+ <td>CIFS (VFS sandbox)</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://www.jcraft.com/jsch/">JSch</a>
+ Version 0.1.42 or later.
+ </td>
+ <td>SFTP</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="http://java.sun.com/products/javamail/">javamail</a>
+ Version 1.4
+ </td>
+ <td>mime (VFS sandbox)</td>
+ </tr>
+ </table>
+ </section>
+ <section name="Building Commons VFS">
+ <p>
+ To obtain the Commons VFS source, you can either:
+ </p>
+ <ul>
+ <li>
+ Check the source out of SVN using:
+ <br/>
+ HEAD:
+ <code>svn co http://svn.apache.org/repos/asf/commons/proper/vfs/trunk vfs</code>
+ <br/>
+ For a certain version please look at
+ <a href="http://svn.apache.org/repos/asf/commons/proper/vfs/tags">
+ http://svn.apache.org/repos/asf/commons/proper/vfs/tags</a>
+ </li>
+ <li>
+ Download a nightly source snapshot from
+ <a href="http://people.apache.org/builds/commons/nightly/commons-vfs/">here</a>
+ .
+ </li>
+ </ul>
+ <p>
+ To build Commons VFS, you can either:
+ </p>
+ <ul>
+ <li>
+ Use
+ <a href="http://maven.apache.org">Maven</a>
+ 2.1.0 or later. Use mvn install to build all the core, examples and sandbox. The
+ jars will then be installed for use by other maven-based builds. The jars can either
+ be copied from the local maven repository or the target sub-directories for non-Maven
+ builds.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download_vfs.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download_vfs.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download_vfs.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/download_vfs.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,138 @@
+<?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.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: download-page-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:download-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | - commons.binary.suffix (optional) |
+ | (defaults to "-bin", set to "" for pre-maven2 releases) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>Download Commons VFS</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+ <section name="Download Commons VFS">
+ <subsection name="Using a Mirror">
+ <p>
+ We recommend you use a mirror to download our release
+ builds, but you <strong>must</strong> verify the integrity of
+ the downloaded files using signatures downloaded from our main
+ distribution directories. Recent releases (48 hours) may not yet
+ be available from the mirrors.
+ </p>
+
+ <p>
+ You are currently using <b>[preferred]</b>. If you
+ encounter a problem with this mirror, please select another
+ mirror. If all mirrors are failing, there are <i>backup</i>
+ mirrors (at the end of the mirrors list) that should be
+ available.
+ <br></br>
+ [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
+ </p>
+
+ <form action="[location]" method="get" id="SelectMirror">
+ <p>
+ Other mirrors:
+ <select name="Preferred">
+ [if-any http]
+ [for http]<option value="[http]">[http]</option>[end]
+ [end]
+ [if-any ftp]
+ [for ftp]<option value="[ftp]">[ftp]</option>[end]
+ [end]
+ [if-any backup]
+ [for backup]<option value="[backup]">[backup] (backup)</option>[end]
+ [end]
+ </select>
+ <input type="submit" value="Change"></input>
+ </p>
+ </form>
+
+ <p>
+ The <a href="http://www.apache.org/dist/commons/KEYS">KEYS</a>
+ link links to the code signing keys used to sign the product.
+ The <code>PGP</code> link downloads the OpenPGP compatible signature from our main site.
+ The <code>MD5</code> link downloads the checksum from the main site.
+ </p>
+ </subsection>
+ </section>
+ <section name="Commons VFS 1.0 ">
+ <subsection name="Binaries">
+ <table>
+ <tr>
+ <td><a href="[preferred]/commons/vfs/binaries/commons-vfs-1.0.tar.gz">commons-vfs-1.0.tar.gz</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/binaries/commons-vfs-1.0.tar.gz.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/binaries/commons-vfs-1.0.tar.gz.asc">pgp</a></td>
+ </tr>
+ <tr>
+ <td><a href="[preferred]/commons/vfs/binaries/commons-vfs-1.0.zip">commons-vfs-1.0.zip</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/binaries/commons-vfs-1.0.zip.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/binaries/commons-vfs-1.0.zip.asc">pgp</a></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Source">
+ <table>
+ <tr>
+ <td><a href="[preferred]/commons/vfs/source/commons-vfs-1.0-src.tar.gz">commons-vfs-1.0-src.tar.gz</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/source/commons-vfs-1.0-src.tar.gz.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/source/commons-vfs-1.0-src.tar.gz.asc">pgp</a></td>
+ </tr>
+ <tr>
+ <td><a href="[preferred]/commons/vfs/source/commons-vfs-1.0-src.zip">commons-vfs-1.0-src.zip</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/source/commons-vfs-1.0-src.zip.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/vfs/source/commons-vfs-1.0-src.zip.asc">pgp</a></td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ <section name="Archives">
+ <p>
+ Older releases can be obtained from the archives.
+ </p>
+ <ul>
+ <li class="download"><a href="[preferred]/commons/vfs/">browse download area</a></li>
+ <li><a href="http://archive.apache.org/dist/commons/vfs/">archives...</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/filesystems.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/filesystems.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/filesystems.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/filesystems.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,592 @@
+<!--
+ 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>Supported File Systems</title>
+ <author email="adammurdoch@apache.org">Adam Murdoch</author>
+ <author email="imario@apache.org">Mario Ivankovits</author>
+ </properties>
+
+ <body>
+ <section name="Supported File Systems">
+ <p>Commons VFS currently supports the following file systems:</p>
+ <ul>
+ <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="#SFTP">SFTP</a>
+ </li>
+ <li>
+ <a href="#Temporary Files">Temporary Files</a>
+ </li>
+ <li>
+ <a href="#Zip, Jar and Tar">Zip, Jar and Tar (uncompressed, tgz or tbz2)</a>
+ </li>
+ <li>
+ <a href="#gzip and bzip2">gzip and bzip2</a>
+ </li>
+ <li>
+ <a href="#res">res</a>
+ </li>
+ <li>
+ <a href="#ram">ram</a>
+ </li>
+ <li>
+ <a href="#mime">mime</a>
+ </li>
+ <li>
+ <a href="#WebDAV">WebDAV</a><br />
+ </li>
+ </ul>
+ </section>
+
+ <section name="Things from the sandbox">
+ <p>The following file systems are in development:</p>
+ <ul>
+ <li>
+ <a href="#CIFS">CIFS</a>
+ </li>
+ <li>
+ <a href="#mime">mime</a>
+ </li>
+ </ul>
+ </section>
+
+ <section name="Naming">
+
+ <p>All filenames are treated as URIs. One of the consequences of this is you have to encode the '%'
+ character using <code>%25</code>. <br />
+ Depending on the filesystem additional characters are encoded if needet. This is done automatically, but
+ might be reflected in the filename.
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>file:///somedir/some%25file.txt</code>
+ </li>
+ </ul>
+ <p>
+ Many file systems accept a userid and password as part of the url. However, storing
+ a password in clear text in a file is usually unacceptable. To help with that
+ Commons VFS provides a mechanism to encrypt the password. It should be noted though,
+ that this is not completely secure since the password needs to be unencrypted
+ before Commons VFS can use it.
+ </p>
+ <p>
+ To create an encrypted password do:
+ </p>
+ <code> java -cp commons-vfs-2.0.jar org.apache.commons.vfs.util.EncryptUtil encrypt mypassword
+ </code>
+ <p>
+ where <i>mypassword</i> is the password you want to encrypt. The result of this will be a
+ single line of output containing uppercase hex characters. For example,
+ </p>
+ <code>
+ java -cp commons-vfs-2.0.jar org.apache.commons.vfs.util.EncryptUtil encrypt WontUBee9
+ D7B82198B272F5C93790FEB38A73C7B8
+ </code>
+ <p>
+ Then cut the output returned and paste it into the URL as:
+ </p>
+ <code>
+ https://testuser:{D7B82198B272F5C93790FEB38A73C7B8}@myhost.com/svn/repos/vfstest/trunk
+ </code>
+ <p>
+ VFS treats a password enclosed in {} as being encrypted and will decrypt the password
+ before using it.
+ </p>
+ </section>
+
+ <section name="Local Files">
+
+ <p>Provides access to the files on the local physical file system.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>[file://]
+ <i>absolute-path</i>
+ </code>
+ </p>
+
+ <p>
+ Where
+ <code>
+ <i>absolute-path</i>
+ </code> is a valid absolute
+ file name for the local platform. UNC names are supported
+ under Windows.
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>file:///home/someuser/somedir</code>
+ </li>
+ <li>
+ <code>file:///C:/Documents and Settings</code>
+ </li>
+ <li>
+ <code>file://///somehost/someshare/afile.txt</code>
+ </li>
+ <li>
+ <code>/home/someuser/somedir</code>
+ </li>
+ <li>
+ <code>c:\program files\some dir</code>
+ </li>
+ <li>
+ <code>c:/program files/some dir</code>
+ </li>
+ </ul>
+ </section>
+
+ <section name="Zip, Jar and Tar">
+
+ <p>Provides read-only access to the contents of Zip, Jar and Tar files.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>zip://
+ <i>arch-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <code>jar://
+ <i>arch-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <code>tar://
+ <i>arch-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <code>tgz://
+ <i>arch-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <code>tbz2://
+ <i>arch-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ Where
+ <code>arch-file-uri</code> refers to a file of any
+ supported type, including other zip files. Note: if you would like
+ to use the ! as normal character it must be escaped
+ using <code>%21</code>.<br />
+ <code>tgz</code> and <code>tbz2</code> are convenience for <code>tar:gz</code> and <code>tar:bz2</code>.
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>jar:../lib/classes.jar!/META-INF/manifest.mf</code>
+ </li>
+ <li>
+ <code>zip:http://somehost/downloads/somefile.zip</code>
+ </li>
+ <li>
+ <code>jar:zip:outer.zip!/nested.jar!/somedir</code>
+ </li>
+ <li>
+ <code>jar:zip:outer.zip!/nested.jar!/some%21dir</code>
+ </li>
+ <li>
+ <code>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</code>
+ </li>
+ <li>
+ <code>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</code>
+ </li>
+ </ul>
+
+ </section>
+
+ <section name="gzip and bzip2">
+
+ <p>Provides read-only access to the contents of gzip and bzip2 files.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>gz://
+ <i>compressed-file-uri</i>
+ </code>
+ </p>
+ <p>
+ <code>bz2://
+ <i>compressed-file-uri</i>
+ </code>
+ </p>
+
+ <p>
+ Where
+ <code>compressed-file-uri</code> refers to a file of any
+ supported type. There is no need to add a ! part to the uri if
+ you read the content of the file you always will get the uncompressed
+ version.
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>gz:/my/gz/file.gz</code>
+ </li>
+ </ul>
+
+ </section>
+
+ <section name="HTTP and HTTPS">
+
+ <p>Provides access to files on an HTTP server.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>http://[
+ <i>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <code>https://[
+ <i>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+ <p>
+ <b>File System Options</b>
+ <ul>
+ <li><b>proxyHost</b> The proxy host to connect through.</li>
+ <li><b>proxyPort</b> The proxy port to use.</li>
+ <li><b>cookies</b> An array of Cookies to add to the request.</li>
+ <li><b>maxConnectionsPerHost</b> The maximum number of connections allowed to
+ a specific host and port. The default is 5.</li>
+ <li><b>maxTotalConnections</b> The maximum number of connections allowed to
+ all hosts. The default is 50.</li>
+ </ul>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>http://somehost:8080/downloads/somefile.jar</code>
+ </li>
+ <li>
+ <code>http://myusername@somehost/index.html</code>
+ </li>
+ </ul>
+ </section>
+
+ <section name="WebDAV">
+
+ <p>Provides access to files on a WebDAV server.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>webdav://[
+ <i>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>File System Options</b>
+ <ul>
+ <li><b>versioning</b> true if versioning should be enabled</li>
+ <li><b>creatorName</b> the user name to be identified with changes to a file. If
+ not set the user name used to authenticate will be used.</li>
+ </ul>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>webdav://somehost:8080/dist</code>
+ </li>
+ </ul>
+ </section>
+
+ <section name="FTP">
+
+ <p>Provides access to the files on an FTP server.</p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>ftp://[
+ <i>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>ftp://myusername:mypassword@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>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+ <ul>
+ <li>
+ <code>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</code>
+ </li>
+ </ul>
+
+ </section>
+
+ <section name="CIFS">
+
+ <p>
+ Provides access to the files on a CIFS server, such as
+ a Samba server, or a Windows share.
+ </p>
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>smb://[
+ <i>username</i>[:
+ <i>password</i>]@]
+ <i>hostname</i>[:
+ <i>port</i>][
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+
+ <ul>
+ <li>
+ <code>smb://somehost/home</code>
+ </li>
+ </ul>
+
+ </section>
+
+ <section name="Temporary Files">
+
+ <p>
+ Provides access to a temporary file system, or scratchpad,
+ that is deleted when Commons VFS shuts down. The temporary file
+ system is backed by a local file system.
+ </p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>tmp://[
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+
+ <ul>
+ <li>
+ <code>tmp://dir/somefile.txt</code>
+ </li>
+ </ul>
+ </section>
+
+ <section name="res">
+
+ <p>
+ This is not really a filesystem, it just tries to lookup a resource using javas <code>ClassLoader.getResource()</code>
+ and creates a VFS url for further processing.
+ </p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>res://[
+ <i>path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+
+ <ul>
+ <li>
+ <code>res:path/in/classpath/image.png</code><br/>
+ might result in
+ <code>jar:file://my/path/to/images.jar!/path/in/classpath/image.png</code><br/>
+ </li>
+ </ul>
+ </section>
+
+ <section name="ram">
+
+ <p>
+ A filesystem which stores all the data in memory.
+ You can configure the max size and a predicate (FileSelector). The predicate will be used to check if
+ it is allowed to add a given file.
+ </p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>ram://[
+ <i>path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+
+ <ul>
+ <li>
+ <code>ram:///any/path/to/file.txt</code>
+ </li>
+ </ul>
+ </section>
+
+ <section name="mime">
+
+ <p>
+ This filesystem can read mails and its attachements like archives.<br />
+ If a part in the parsed mail has no name, a dummy name will be generated.
+ The dummy name is: _body_part_X where X will be replaced by the part number.
+ </p>
+
+ <p>
+ <b>URI Format</b>
+ </p>
+
+ <p>
+ <code>mime://
+ <i>mime-file-uri</i>[!
+ <i>absolute-path</i>]
+ </code>
+ </p>
+
+ <p>
+ <b>Examples</b>
+ </p>
+
+ <ul>
+ <li>
+ <code>mime:file:///your/path/mail/anymail.mime!/</code>
+ </li>
+ <li>
+ <code>mime:file:///your/path/mail/anymail.mime!/filename.pdf</code>
+ </li>
+ <li>
+ <code>mime:file:///your/path/mail/anymail.mime!/_body_part_0</code>
+ </li>
+ </ul>
+ </section>
+
+ </body>
+</document>
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/index.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/index.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/index.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,94 @@
+<?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>Commons Virtual File System</title>
+ <author email="jstrachan@apache.org">James Strachan</author>
+ </properties>
+
+ <body>
+ <section name="Commons Virtual File System">
+
+ <p>
+ Commons VFS provides a single API for accessing
+ various different file systems. It presents a uniform view of
+ the files from various different sources, such as the files on
+ local disk, on an HTTP server, or inside a Zip archive.
+ </p>
+
+ <p>Some of the features of Commons VFS are:</p>
+ <ul>
+ <li>
+ A single consistent API for accessing files of different
+ types.
+ </li>
+ <li>Support for numerous
+ <a href="filesystems.html">file system types</a>
+ .
+ </li>
+ <li>
+ Caching of file information. Caches information in-JVM,
+ and optionally can cache remote file information on the
+ local file system.
+ </li>
+ <li>Event delivery.</li>
+ <li>
+ Support for logical file systems made up of files from
+ various different file systems.
+ </li>
+ <li>
+ Utilities for integrating Commons VFS into applications,
+ such as a VFS-aware ClassLoader and URLStreamHandlerFactory.
+ </li>
+ <li>A set of VFS-enabled
+ <a href="anttasks.html">Ant tasks</a>
+ .
+ </li>
+ </ul>
+
+ </section>
+
+ <section name="News">
+ <p>
+ VFS is split into core, examples and sandbox now.
+ </p>
+ <p>
+ Due to some technical reasons we had to move the jcifs (smb) filesystem to
+ the sandbox. So if you need one of these filesystems you have to build VFS manually.
+ </p>
+ <p>
+ To build VFS, it will be best to check-it-out from svn and use maven 2 to
+ build.
+ </p>
+ <p>
+ And - we have a new filesystem: mime (read only for sure)<br/>
+ This filesystem allows you to read e-mails like archives, e.g. the attachments are the
+ children of the mail itself.<br />
+ You'll find it in our sandbox.
+ </p>
+ <p>
+ Also notice that we now have a "3rd party plugins" page. It will list all external
+ plugins available for VFS.<br />
+ You have such a beast - and will get listed? Just drop me a mail: imario -at- apache.org
+ </p>
+ </section>
+
+ </body>
+</document>
+
Added: synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/issue-tracking.xml
URL: http://svn.apache.org/viewvc/synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/issue-tracking.xml?rev=1000332&view=auto
==============================================================================
--- synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/issue-tracking.xml (added)
+++ synapse/branches/commons-vfs-2-synapse-2.0/src/site/xdoc/issue-tracking.xml Thu Sep 23 06:04:21 2010
@@ -0,0 +1,102 @@
+<?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.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: issue-tracking-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.id (required, alphabetic, upper case) |
+ | - commons.jira.pid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.id>MATH</commons.jira.id> |
+ | <commons.jira.pid>12310485</commons.jira.pid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>Commons VFS Issue tracking</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="Commons VFS Issue tracking">
+ <p>
+ Commons VFS uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+ See the <a href="http://issues.apache.org/jira/browse/VFS">Commons VFS JIRA project page</a>.
+ </p>
+
+ <p>
+ To use JIRA you may need to <a href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
+ (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
+ created and you can use the <a href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
+ page to get a new password).
+ </p>
+
+ <p>
+ If you would like to report a bug, or raise an enhancement request with
+ Commons VFS please do the following:
+ <ol>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310495&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
+ If you find your issue listed then please add a comment with your details.</li>
+ <li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
+ You may find your issue or idea has already been discussed.</li>
+ <li>Decide if your issue is a bug or an enhancement.</li>
+ <li>Submit either a <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310495&issuetype=1&priority=4&assignee=-1">bug report</a>
+ or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310495&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <ul>
+ <li>the more information you provide, the better we can help you</li>
+ <li>test cases are vital, particularly for any proposed enhancements</li>
+ <li>the developers of Commons VFS are all unpaid volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on subversion and creating patches see the
+ <a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310495&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Commons VFS bugs</a></li>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310495&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Commons VFS bugs</a></li>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310495&sorter/field=issuekey&sorter/order=DESC">All Commons VFS bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>