com.lf.vfslib.net

Class VFSFileSystemManager

java.lang.Object

org.apache.commons.vfs2.impl.DefaultFileSystemManager

org.apache.commons.vfs2.impl.StandardFileSystemManager

com.lf.vfslib.net.VFSFileSystemManager

All Implemented Interfaces:

AutoCloseable, org.apache.commons.vfs2.FileSystemManager

public class VFSFileSystemManager
extends org.apache.commons.vfs2.impl.StandardFileSystemManager

Commons specific FileSystemManager managing protocol options etc.

Main reason for this class is the possiblity to install options for each of the schemes which are used by the overwritten resolve() methods automatically. The original FileSystemManager implementations also lack support for various functions as to mention the direct removal of already installed schemes.

Since:

1.6

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
VFSFileSystemManager() Constructor method using the default configuration.
VFSFileSystemManager(URL configuri) Constructor method using the given configuration.

Method Summary

Modifier and Type	Method and Description
void	addConnection(VFSConnection vfsconn) Adds a new network connections for this manager.
VFSConnection	getBestConnection(String uri) Searches the configured connections for an appropriate instance (scheme, host, ...).
Vector<VFSConnection>	getConnections() Provides the currently configured network connections for this manager.
org.apache.commons.vfs2.provider.FileProvider	getProvider(String scheme) Provides the provider for the given scheme/protocol.
Map	getProviders() Provides the cache with scheme providers.
org.apache.commons.vfs2.operations.FileOperationProvider	removeOperationProvider(String protocol) Removes the FileOperationProvider for the specified scheme.
org.apache.commons.vfs2.FileObject	resolveFile(org.apache.commons.vfs2.FileObject baseFile, String uri) Resolves a URI, relative to a base file.
org.apache.commons.vfs2.FileObject	resolveFile(org.apache.commons.vfs2.FileObject baseFile, String uri, VFSConnection vfsconn) Resolves a URI, relative to a base file.
org.apache.commons.vfs2.FileObject	resolveFile(File baseFile, String uri) Resolves a URI, relative to a base file.
org.apache.commons.vfs2.FileObject	resolveFile(File baseFile, String uri, VFSConnection vfsconn) Resolves a URI, relative to a base file.
org.apache.commons.vfs2.FileObject	resolveFile(String uri) Locates a file by URI.
org.apache.commons.vfs2.FileObject	resolveFile(String uri, org.apache.commons.vfs2.FileSystemOptions options) Locates a file by URI and file system options.
org.apache.commons.vfs2.FileObject	resolveFile(String uri, org.apache.commons.vfs2.FileSystemOptions options, VFSConnection vfsconn) Locates a file by URI.
org.apache.commons.vfs2.FileObject	resolveFile(String uri, VFSConnection vfsconn) Locates a file by URI.
void	setConnections(Vector<VFSConnection> connections) Sets the currently configured network connections for this manager.

Methods inherited from class org.apache.commons.vfs2.impl.StandardFileSystemManager

init, setClassLoader, setConfiguration, setConfiguration

Methods inherited from class org.apache.commons.vfs2.impl.DefaultFileSystemManager

_closeFileSystem, addExtensionMap, addMimeTypeMap, addOperationProvider, addOperationProvider, addProvider, addProvider, canCreateFileSystem, close, closeFileSystem, createFileSystem, createFileSystem, createVirtualFileSystem, createVirtualFileSystem, freeUnusedResources, getBaseFile, getCacheStrategy, getFileContentInfoFactory, getFileObjectDecorator, getFileObjectDecoratorConst, getFilesCache, getFileSystemConfigBuilder, getOperationProviders, getProviderCapabilities, getReplicator, getSchemes, getTemporaryFileStore, getURLStreamHandlerFactory, hasProvider, removeProvider, resolveFile, resolveFile, resolveFile, resolveName, resolveName, resolveURI, setBaseFile, setBaseFile, setCacheStrategy, setDefaultProvider, setFileContentInfoFactory, setFileObjectDecorator, setFilesCache, setLogger, setReplicator, setTemporaryFileStore, toFileObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VFSFileSystemManager

public VFSFileSystemManager()

Constructor method using the default configuration.

Since:

1.6

VFSFileSystemManager

public VFSFileSystemManager(URL configuri)

Constructor method using the given configuration.

Parameters:

configuri - The descriptor resource path

Throws:

NullPointerException - If a parameter is null

Since:

1.6

Method Detail

getProviders

public Map getProviders()

Provides the cache with scheme providers.

Returns:

The cache, may be null

Since:

1.6

getProvider

public org.apache.commons.vfs2.provider.FileProvider getProvider(String scheme)

Provides the provider for the given scheme/protocol.

Parameters:

scheme - The protocol like "sftp"

Returns:

The provider, may be null

Since:

1.6

removeOperationProvider

public org.apache.commons.vfs2.operations.FileOperationProvider removeOperationProvider(String protocol)

Removes the FileOperationProvider for the specified scheme.

Another alternative would be to specify a modified "providers.xml" for the 2nd constructor. The original FileSystemManager lacks this functionality of directly removing already installed providers.

Parameters:

protocol - The VFS scheme like "sftp"

Returns:

The provider, may be null

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(String uri)
                                               throws org.apache.commons.vfs2.FileSystemException

Locates a file by URI.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Specified by:

resolveFile in interface org.apache.commons.vfs2.FileSystemManager

Overrides:

resolveFile in class org.apache.commons.vfs2.impl.DefaultFileSystemManager

Parameters:

uri - The URI to resolve

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(String uri,
                                                      VFSConnection vfsconn)
                                               throws org.apache.commons.vfs2.FileSystemException

Locates a file by URI.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Parameters:

uri - The URI to resolve

vfsconn - The connection with options

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(String uri,
                                                      org.apache.commons.vfs2.FileSystemOptions options)
                                               throws org.apache.commons.vfs2.FileSystemException

Locates a file by URI and file system options.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Specified by:

resolveFile in interface org.apache.commons.vfs2.FileSystemManager

Overrides:

resolveFile in class org.apache.commons.vfs2.impl.DefaultFileSystemManager

Parameters:

uri - The URI to resolve

options - The file system options

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(String uri,
                                                      org.apache.commons.vfs2.FileSystemOptions options,
                                                      VFSConnection vfsconn)
                                               throws org.apache.commons.vfs2.FileSystemException

Locates a file by URI.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Parameters:

uri - The URI to resolve

options - The file system options

vfsconn - The connection with options

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(File baseFile,
                                                      String uri)
                                               throws org.apache.commons.vfs2.FileSystemException

Resolves a URI, relative to a base file.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Specified by:

resolveFile in interface org.apache.commons.vfs2.FileSystemManager

Overrides:

resolveFile in class org.apache.commons.vfs2.impl.DefaultFileSystemManager

Parameters:

baseFile - The base file

uri - The URI to resolve

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(File baseFile,
                                                      String uri,
                                                      VFSConnection vfsconn)
                                               throws org.apache.commons.vfs2.FileSystemException

Resolves a URI, relative to a base file.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Parameters:

baseFile - The base file

uri - The URI to resolve

vfsconn - The connection with options

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(org.apache.commons.vfs2.FileObject baseFile,
                                                      String uri)
                                               throws org.apache.commons.vfs2.FileSystemException

Resolves a URI, relative to a base file.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Specified by:

resolveFile in interface org.apache.commons.vfs2.FileSystemManager

Overrides:

resolveFile in class org.apache.commons.vfs2.impl.DefaultFileSystemManager

Parameters:

baseFile - The base file

uri - The URI to resolve

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

resolveFile

public org.apache.commons.vfs2.FileObject resolveFile(org.apache.commons.vfs2.FileObject baseFile,
                                                      String uri,
                                                      VFSConnection vfsconn)
                                               throws org.apache.commons.vfs2.FileSystemException

Resolves a URI, relative to a base file.

If installed the file system options e.g. for schemes like "sftp" are applied here.

Parameters:

baseFile - The base file

uri - The URI to resolve

vfsconn - The connection with options

Returns:

The network file

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

getConnections

public Vector<VFSConnection> getConnections()

Provides the currently configured network connections for this manager.

Returns:

The connections (original reference, take care)

Since:

1.6

setConnections

public void setConnections(Vector<VFSConnection> connections)

Sets the currently configured network connections for this manager.

Parameters:

connections - The connections

Throws:

NullPointerException - If a parameter is null

Since:

1.6

addConnection

public void addConnection(VFSConnection vfsconn)

Adds a new network connections for this manager.

Parameters:

vfsconn - The connection

Throws:

NullPointerException - If a parameter is null

Since:

1.6

getBestConnection

public VFSConnection getBestConnection(String uri)

Searches the configured connections for an appropriate instance (scheme, host, ...).

This way it is possible to access files on servers with special params like passive FTP by a simple URL which may be specified on the command line (and which lacks the connection options).

Parameters:

uri - The network file to check

Returns:

The connection, may be null

Since:

1.6