org.apache.commons.vfs2.provider

Interface VfsComponentContext

public interface VfsComponentContext

Allows VFS components to access the services they need, such as the file replicator. A VFS component is supplied with a context as part of its initialization.

See Also:

VfsComponent.setContext(org.apache.commons.vfs2.provider.VfsComponentContext)

Method Summary

Modifier and Type	Method and Description
FileSystemManager	getFileSystemManager() Gets the file system manager for the current context.
FileReplicator	getReplicator() Gets a file replicator for the provider to use.
TemporaryFileStore	getTemporaryFileStore() Gets a temporary file store for the provider to use.
FileName	parseURI(String uri) Parses a URI into a FileName.
FileObject	resolveFile(FileObject baseFile, String name, FileSystemOptions fileSystemOptions) Resolves a file by name.
FileObject	resolveFile(String name, FileSystemOptions fileSystemOptions) Resolves a file by name.
FileObject	toFileObject(File file) Returns a FileObject for a local file.

Method Detail

resolveFile

FileObject resolveFile(FileObject baseFile,
                       String name,
                       FileSystemOptions fileSystemOptions)
                throws FileSystemException

Resolves a file by name. See FileSystemManager.resolveFile(FileObject, String) for a description of how this works.

Parameters:

baseFile - The base FileObject.

name - The name of the file to locate.

fileSystemOptions - The FileSystemOptions.

Returns:

The FileObject for the located file.

Throws:

FileSystemException - if an error occurs.

resolveFile

FileObject resolveFile(String name,
                       FileSystemOptions fileSystemOptions)
                throws FileSystemException

Resolves a file by name. See FileSystemManager.resolveFile( String) for a description of how this works.

Parameters:

name - The name of the file to locate.

fileSystemOptions - The FileSystemOptions.

Returns:

The FileObject for the located file.

Throws:

FileSystemException - if an error occurs.

parseURI

FileName parseURI(String uri)
           throws FileSystemException

Parses a URI into a FileName.

Parameters:

uri - The URI String.

Returns:

The FileName.

Throws:

FileSystemException - if an error occurs.

getReplicator

FileReplicator getReplicator()
                      throws FileSystemException

Gets a file replicator for the provider to use.

Returns:

The FileReplicator.

Throws:

FileSystemException - if an error occurs.

getTemporaryFileStore

TemporaryFileStore getTemporaryFileStore()
                                  throws FileSystemException

Gets a temporary file store for the provider to use.

Returns:

The TemporaryFileStore.

Throws:

FileSystemException - if an error occurs.

toFileObject

FileObject toFileObject(File file)
                 throws FileSystemException

Returns a FileObject for a local file.

Parameters:

file - The File to convert to a FileObject.

Returns:

the FileObject.

Throws:

FileSystemException - if an error occurs.

getFileSystemManager

FileSystemManager getFileSystemManager()

Gets the file system manager for the current context.

Returns:

the file system manager