Class UrlFileProvider

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.url.UrlFileProvider

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, VfsComponent

public class UrlFileProvider
extends AbstractFileProvider

A file provider backed by Java's URL API.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Collection<Capability>	capabilities	The provider's capabilities

Constructor Summary

Constructors

Constructor	Description
UrlFileProvider()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
FileObject	findFile(FileObject baseFile, String fileUri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
Collection<Capability>	getCapabilities()	Gets the file system capabilities.
FileSystemConfigBuilder	getConfigBuilder()	Gets the FileSystemConfigBuilder.

Methods inherited from class AbstractFileProvider

addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser

Methods inherited from class AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class Object

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

Field Details

capabilities

protected static final Collection<Capability> capabilities

The provider's capabilities

Constructor Details

UrlFileProvider

public UrlFileProvider()

Constructs a new instance.

Method Details

findFile

public FileObject findFile(FileObject baseFile,
 String fileUri,
 FileSystemOptions fileSystemOptions)
                    throws FileSystemException

Locates a file object, by absolute URI.

Parameters:

baseFile - The base FileObject.

fileUri - The uri of the file to locate.

fileSystemOptions - The FileSystemOptions

Returns:

The FileObject

Throws:

FileSystemException - if an error occurs.

getCapabilities

public Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Gets the file system capabilities.

These are the same as on the file system, but available before the first file system was instantiated.

Returns:

a Collection of the file systems Capabilities.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()

Description copied from class: AbstractFileProvider

Gets the FileSystemConfigBuilder.

Specified by:

getConfigBuilder in interface FileProvider

Overrides:

getConfigBuilder in class AbstractFileProvider

Returns:

the FileSystemConfigBuilder.