Package org.apache.commons.vfs2.provider

Class AbstractOriginatingFileProvider

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractVfsContainer

org.apache.commons.vfs2.provider.AbstractFileProvider

org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, FileProvider, VfsComponent

Direct Known Subclasses:

DefaultLocalFileProvider, FtpFileProvider, Http4FileProvider, HttpFileProvider, RamFileProvider, SftpFileProvider

public abstract class AbstractOriginatingFileProvider
extends AbstractFileProvider

A FileProvider that handles physical files, such as the files in a local fs, or on an FTP server. An originating file system cannot be layered on top of another file system.

Constructor Summary

Constructors

Constructor	Description
AbstractOriginatingFileProvider()	Constructs a new instance for subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract FileSystem	doCreateFileSystem(FileName rootFileName, FileSystemOptions fileSystemOptions)	Creates a FileSystem.
protected FileObject	findFile(FileName fileName, FileSystemOptions fileSystemOptions)	Locates a file from its parsed URI.
FileObject	findFile(FileObject baseFileObject, java.lang.String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
protected FileSystem	getFileSystem(FileName rootFileName, FileSystemOptions fileSystemOptions)	Returns the FileSystem associated with the specified root.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider

addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getConfigBuilder, 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

Methods inherited from interface org.apache.commons.vfs2.provider.FileProvider

getCapabilities

Constructor Detail

AbstractOriginatingFileProvider

public AbstractOriginatingFileProvider()

Constructs a new instance for subclasses.

Method Detail

doCreateFileSystem

protected abstract FileSystem doCreateFileSystem(FileName rootFileName,
                                                 FileSystemOptions fileSystemOptions)
                                          throws FileSystemException

Creates a FileSystem. If the returned FileSystem implements VfsComponent, it will be initialized.

Parameters:

rootFileName - The name of the root file of the file system to create.

fileSystemOptions - The FileSystem options.

Returns:

The FileSystem, never null.

Throws:

FileSystemException - if an error occurs.

findFile

protected FileObject findFile(FileName fileName,
                              FileSystemOptions fileSystemOptions)
                       throws FileSystemException

Locates a file from its parsed URI.

Parameters:

fileName - The file name.

fileSystemOptions - FileSystem options.

Returns:

A FileObject associated with the file, never null.

Throws:

FileSystemException - if an error occurs.

findFile

public FileObject findFile(FileObject baseFileObject,
                           java.lang.String uri,
                           FileSystemOptions fileSystemOptions)
                    throws FileSystemException

Locates a file object, by absolute URI.

Parameters:

baseFileObject - The base file object.

uri - The URI of the file to locate

fileSystemOptions - The FileSystem options.

Returns:

The located FileObject

Throws:

FileSystemException - if an error occurs.

getFileSystem

protected FileSystem getFileSystem(FileName rootFileName,
                                   FileSystemOptions fileSystemOptions)
                            throws FileSystemException

Returns the FileSystem associated with the specified root.

Parameters:

rootFileName - The root path.

fileSystemOptions - The FileSystem options.

Returns:

The FileSystem, never null.

Throws:

FileSystemException - if an error occurs.

Since:

2.0