org.apache.commons.vfs2.provider.webdav
Class WebdavFileProvider

java.lang.Object
  extended by org.apache.commons.vfs2.provider.AbstractVfsComponent
      extended by org.apache.commons.vfs2.provider.AbstractVfsContainer
          extended by org.apache.commons.vfs2.provider.AbstractFileProvider
              extended by org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
                  extended by org.apache.commons.vfs2.provider.http.HttpFileProvider
                      extended by org.apache.commons.vfs2.provider.webdav.WebdavFileProvider
All Implemented Interfaces:
FileProvider, VfsComponent

public class WebdavFileProvider
extends HttpFileProvider

A provider for WebDAV.

Since:
2.0
Author:
Commons VFS team

Field Summary
static UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
          The authenticator types used by the WebDAV provider.
protected static java.util.Collection<Capability> capabilities
          The capabilities of the WebDAV provider
 
Constructor Summary
WebdavFileProvider()
           
 
Method Summary
protected  FileSystem doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)
          Creates a FileSystem.
 java.util.Collection<Capability> getCapabilities()
          Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.
 FileSystemConfigBuilder getConfigBuilder()
          Returns the FileSystemConfigBuidler.
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
findFile, findFile, getFileSystem
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer
addComponent, removeComponent
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, init, setContext, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AUTHENTICATOR_TYPES

public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
The authenticator types used by the WebDAV provider.


capabilities

protected static final java.util.Collection<Capability> capabilities
The capabilities of the WebDAV provider

Constructor Detail

WebdavFileProvider

public WebdavFileProvider()
Method Detail

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
                                        FileSystemOptions fileSystemOptions)
                                 throws FileSystemException
Creates a FileSystem. If you're looking at this method and wondering how to get a FileSystemOptions object bearing the proxy host and credentials configuration through to this method so it's used for resolving a FileObject in the FileSystem, then be sure to use correct signature of the FileSystemManager resolveFile method.

Overrides:
doCreateFileSystem in class HttpFileProvider
Parameters:
name - The name of the root file of the file system to create.
fileSystemOptions - The FileSystem options.
Returns:
The FileSystem.
Throws:
FileSystemException - if an error occurs.
See Also:
DefaultFileSystemManager.resolveFile(FileObject, String, FileSystemOptions)

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()
Description copied from class: AbstractFileProvider
Returns the FileSystemConfigBuidler.

Specified by:
getConfigBuilder in interface FileProvider
Overrides:
getConfigBuilder in class HttpFileProvider
Returns:
the FileSystemConfigBuilder.

getCapabilities

public java.util.Collection<Capability> getCapabilities()
Description copied from interface: FileProvider
Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.

Specified by:
getCapabilities in interface FileProvider
Overrides:
getCapabilities in class HttpFileProvider
Returns:
a Collection of the file systems Capabilities.