Uses of Class
org.apache.commons.vfs.FileSystemOptions

Packages that use FileSystemOptions

Package	Description
org.apache.commons.vfs	The public VFS API.
org.apache.commons.vfs.impl	The standard VFS implementation.
org.apache.commons.vfs.provider	The File Provider API, and utility classes.
org.apache.commons.vfs.provider.bzip2
org.apache.commons.vfs.provider.compressed
org.apache.commons.vfs.provider.ftp	The FTP File Provider.
org.apache.commons.vfs.provider.gzip
org.apache.commons.vfs.provider.http
org.apache.commons.vfs.provider.jar	The Jar File Provider.
org.apache.commons.vfs.provider.local	The Local File Provider.
org.apache.commons.vfs.provider.ram	The RAM File Provider.
org.apache.commons.vfs.provider.res
org.apache.commons.vfs.provider.sftp	The SFTP Provider.
org.apache.commons.vfs.provider.tar	The Tar File Provider.
org.apache.commons.vfs.provider.temp	The Temporary Filespace Provider.
org.apache.commons.vfs.provider.url	The Default File Provider, which wraps java.net.URL.
org.apache.commons.vfs.provider.zip	The Zip File Provider.
org.apache.commons.vfs.util	Utility classes used by the VFS.

Uses of FileSystemOptions in org.apache.commons.vfs

Methods in org.apache.commons.vfs that return FileSystemOptions

Modifier and Type	Method	Description
FileSystemOptions	FileSystem.getFileSystemOptions()	Returns the FileSystemOptions used to instantiate this filesystem

Methods in org.apache.commons.vfs with parameters of type FileSystemOptions

Modifier and Type	Method	Description
int	FileSystemOptions.compareTo(FileSystemOptions other)
protected Object	FileSystemConfigBuilder.getParam(FileSystemOptions opts, String name)
protected boolean	FileSystemConfigBuilder.hasParam(FileSystemOptions opts, String name)
FileObject	FileSystemManager.resolveFile(String name, FileSystemOptions fileSystemOptions)	Locates a file by name.
protected void	FileSystemConfigBuilder.setParam(FileSystemOptions opts, String name, Object value)

Uses of FileSystemOptions in org.apache.commons.vfs.impl

Methods in org.apache.commons.vfs.impl with parameters of type FileSystemOptions

Modifier and Type	Method	Description
UserAuthenticator	DefaultFileSystemConfigBuilder.getUserAuthenticator(FileSystemOptions opts)
FileObject	DefaultFileSystemManager.resolveFile(String uri, FileSystemOptions fileSystemOptions)	Locate a file by URI, use the FileSystemOptions for file-system creation
FileObject	DefaultFileSystemManager.resolveFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Resolves a URI, realtive to a base file with specified FileSystem configuration
void	DefaultFileSystemConfigBuilder.setUserAuthenticator(FileSystemOptions opts, UserAuthenticator userAuthenticator)	Sets the user authenticator to get authentication informations

Constructors in org.apache.commons.vfs.impl with parameters of type FileSystemOptions

Modifier	Constructor	Description
	VirtualFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider

Methods in org.apache.commons.vfs.provider that return FileSystemOptions

Modifier and Type	Method	Description
FileSystemOptions	AbstractFileSystem.getFileSystemOptions()	Return the FileSystemOptions used to instantiate this filesystem

Methods in org.apache.commons.vfs.provider with parameters of type FileSystemOptions

Modifier and Type	Method	Description
FileObject	AbstractFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions properties)	Creates a layered file system.
FileObject	AbstractLayeredFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
FileObject	FileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected abstract FileSystem	AbstractLayeredFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected abstract FileSystem	AbstractOriginatingFileProvider.doCreateFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)	Creates a FileSystem.
FileObject	AbstractLayeredFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions properties)	Locates a file object, by absolute URI.
protected FileObject	AbstractOriginatingFileProvider.findFile(FileName name, FileSystemOptions fileSystemOptions)	Locates a file from its parsed URI.
FileObject	AbstractOriginatingFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	CompositeFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	FileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
protected FileSystem	AbstractFileProvider.findFileSystem(Comparable key, FileSystemOptions fileSystemProps)	Locates a cached file system
FileObject	VfsComponentContext.resolveFile(String name, FileSystemOptions fileSystemOptions)	Locate a file by name.
FileObject	VfsComponentContext.resolveFile(FileObject baseFile, String name, FileSystemOptions fileSystemOptions)	Locate a file by name.

Constructors in org.apache.commons.vfs.provider with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	AbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)
	DefaultURLStreamHandler(VfsComponentContext context, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.bzip2

Methods in org.apache.commons.vfs.provider.bzip2 with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	Bzip2FileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)

Constructors in org.apache.commons.vfs.provider.bzip2 with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	Bzip2FileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.compressed

Methods in org.apache.commons.vfs.provider.compressed with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected abstract FileSystem	CompressedFileFileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)
protected FileSystem	CompressedFileFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs.provider.compressed with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	CompressedFileFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.ftp

Methods in org.apache.commons.vfs.provider.ftp with parameters of type FileSystemOptions

Modifier and Type	Method	Description
static org.apache.commons.net.ftp.FTPClient	FtpClientFactory.createConnection(String hostname, int port, char[] username, char[] password, String workingDirectory, FileSystemOptions fileSystemOptions)	Creates a new connection to the server.
protected FileSystem	FtpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the filesystem.
Integer	FtpFileSystemConfigBuilder.getDataTimeout(FileSystemOptions opts)
String	FtpFileSystemConfigBuilder.getDefaultDateFormat(FileSystemOptions opts)	get the language code used by the server.
String	FtpFileSystemConfigBuilder.getEntryParser(FileSystemOptions opts)
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory	FtpFileSystemConfigBuilder.getEntryParserFactory(FileSystemOptions opts)
Boolean	FtpFileSystemConfigBuilder.getPassiveMode(FileSystemOptions opts)
String	FtpFileSystemConfigBuilder.getRecentDateFormat(FileSystemOptions opts)	see FTPClientConfig for details and examples.
String	FtpFileSystemConfigBuilder.getServerLanguageCode(FileSystemOptions opts)	get the language code used by the server.
String	FtpFileSystemConfigBuilder.getServerTimeZoneId(FileSystemOptions opts)	see FTPClientConfig for details and examples.
String[]	FtpFileSystemConfigBuilder.getShortMonthNames(FileSystemOptions opts)	see FTPClientConfig for details and examples.
Boolean	FtpFileSystemConfigBuilder.getUserDirIsRoot(FileSystemOptions opts)
void	FtpFileSystemConfigBuilder.setDataTimeout(FileSystemOptions opts, Integer dataTimeout)	set the data timeout for the ftp client. If you set the dataTimeout to null no dataTimeout will be set on the ftp client.
void	FtpFileSystemConfigBuilder.setDefaultDateFormat(FileSystemOptions opts, String defaultDateFormat)	set the language code used by the server.
void	FtpFileSystemConfigBuilder.setEntryParser(FileSystemOptions opts, String key)	set the FQCN of your FileEntryParser used to parse the directory listing from your server. If you do not use the default commons-net FTPFileEntryParserFactory e.g.
void	FtpFileSystemConfigBuilder.setEntryParserFactory(FileSystemOptions opts, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)	FTPFileEntryParserFactory which will be used for ftp-entry parsing
void	FtpFileSystemConfigBuilder.setPassiveMode(FileSystemOptions opts, boolean passiveMode)	enter into passive mode
void	FtpFileSystemConfigBuilder.setRecentDateFormat(FileSystemOptions opts, String recentDateFormat)	see FTPClientConfig for details and examples.
void	FtpFileSystemConfigBuilder.setServerLanguageCode(FileSystemOptions opts, String serverLanguageCode)	set the language code used by the server.
void	FtpFileSystemConfigBuilder.setServerTimeZoneId(FileSystemOptions opts, String serverTimeZoneId)	see FTPClientConfig for details and examples.
void	FtpFileSystemConfigBuilder.setShortMonthNames(FileSystemOptions opts, String[] shortMonthNames)	see FTPClientConfig for details and examples.
void	FtpFileSystemConfigBuilder.setUserDirIsRoot(FileSystemOptions opts, boolean userDirIsRoot)	use user directory as root (do not change to fs root)

Constructors in org.apache.commons.vfs.provider.ftp with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	FtpFileSystem(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.gzip

Methods in org.apache.commons.vfs.provider.gzip with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	GzipFileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)

Constructors in org.apache.commons.vfs.provider.gzip with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	GzipFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.http

Methods in org.apache.commons.vfs.provider.http with parameters of type FileSystemOptions

Modifier and Type	Method	Description
static org.apache.commons.httpclient.HttpClient	HttpClientFactory.createConnection(String scheme, String hostname, int port, String username, String password, FileSystemOptions fileSystemOptions)	Creates a new connection to the server.
protected FileSystem	HttpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates a FileSystem.
org.apache.commons.httpclient.Cookie[]	HttpFileSystemConfigBuilder.getCookies(FileSystemOptions opts)	The cookies to add to the reqest
UserAuthenticator	HttpFileSystemConfigBuilder.getProxyAuthenticator(FileSystemOptions opts)	Get the proxy authenticator where the system should get the credentials from
String	HttpFileSystemConfigBuilder.getProxyHost(FileSystemOptions opts)	Get the proxy to use for http connection You have to set the ProxyPort too if you would like to have the proxy relly used.
int	HttpFileSystemConfigBuilder.getProxyPort(FileSystemOptions opts)	Get the proxy-port to use for http the connection You have to set the ProxyHost too if you would like to have the proxy relly used.
String	HttpFileSystemConfigBuilder.getUrlCharset(FileSystemOptions opts)	Set the charset used for url encoding
void	HttpFileSystemConfigBuilder.setCookies(FileSystemOptions opts, org.apache.commons.httpclient.Cookie[] cookies)	The cookies to add to the reqest
void	HttpFileSystemConfigBuilder.setProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator)	Set the proxy authenticator where the system should get the credentials from
void	HttpFileSystemConfigBuilder.setProxyHost(FileSystemOptions opts, String proxyHost)	Set the proxy to use for http connection. You have to set the ProxyPort too if you would like to have the proxy relly used.
void	HttpFileSystemConfigBuilder.setProxyPort(FileSystemOptions opts, int proxyPort)	Set the proxy-port to use for http connection You have to set the ProxyHost too if you would like to have the proxy relly used.
void	HttpFileSystemConfigBuilder.setUrlCharset(FileSystemOptions opts, String chaset)	Set the charset used for url encoding

Constructors in org.apache.commons.vfs.provider.http with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	HttpFileSystem(GenericFileName rootName, org.apache.commons.httpclient.HttpClient client, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.jar

Methods in org.apache.commons.vfs.provider.jar with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	JarFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs.provider.jar with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	JarFileSystem(FileName rootName, FileObject file, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.local

Methods in org.apache.commons.vfs.provider.local with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	DefaultLocalFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the filesystem.

Constructors in org.apache.commons.vfs.provider.local with parameters of type FileSystemOptions

Modifier	Constructor	Description
	LocalFileSystem(FileName rootName, String rootFile, FileSystemOptions opts)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.ram

Methods in org.apache.commons.vfs.provider.ram with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	RamFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)
int	RamFileSystemConfigBuilder.getMaxSize(FileSystemOptions opts)
void	RamFileSystemConfigBuilder.setMaxSize(FileSystemOptions opts, int sizeInBytes)	sets the maximum size of the file system

Constructors in org.apache.commons.vfs.provider.ram with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	RamFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.res

Methods in org.apache.commons.vfs.provider.res with parameters of type FileSystemOptions

Modifier and Type	Method	Description
FileObject	ResourceFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
ClassLoader	ResourceFileSystemConfigBuilder.getClassLoader(FileSystemOptions opts)
void	ResourceFileSystemConfigBuilder.setClassLoader(FileSystemOptions opts, ClassLoader classLoader)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.sftp

Methods in org.apache.commons.vfs.provider.sftp with parameters of type FileSystemOptions

Modifier and Type	Method	Description
static com.jcraft.jsch.Session	SftpClientFactory.createConnection(String hostname, int port, char[] username, char[] password, FileSystemOptions fileSystemOptions)	Creates a new connection to the server.
protected FileSystem	SftpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates a FileSystem.
String	SftpFileSystemConfigBuilder.getCompression(FileSystemOptions opts)
File[]	SftpFileSystemConfigBuilder.getIdentities(FileSystemOptions opts)
File	SftpFileSystemConfigBuilder.getKnownHosts(FileSystemOptions opts)
String	SftpFileSystemConfigBuilder.getProxyHost(FileSystemOptions opts)	Get the proxy to use for sftp connection You have to set the ProxyPort too if you would like to have the proxy relly used.
int	SftpFileSystemConfigBuilder.getProxyPort(FileSystemOptions opts)	Get the proxy-port to use for sftp the connection You have to set the ProxyHost too if you would like to have the proxy relly used.
SftpFileSystemConfigBuilder.ProxyType	SftpFileSystemConfigBuilder.getProxyType(FileSystemOptions opts)	Get the proxy type to use for sftp connection.
String	SftpFileSystemConfigBuilder.getStrictHostKeyChecking(FileSystemOptions opts)
Integer	SftpFileSystemConfigBuilder.getTimeout(FileSystemOptions opts)
Boolean	SftpFileSystemConfigBuilder.getUserDirIsRoot(FileSystemOptions opts)
com.jcraft.jsch.UserInfo	SftpFileSystemConfigBuilder.getUserInfo(FileSystemOptions opts)
void	SftpFileSystemConfigBuilder.setCompression(FileSystemOptions opts, String compression)	configure the compression to use. e.g.
void	SftpFileSystemConfigBuilder.setIdentities(FileSystemOptions opts, File[] identities)	Set the identity files (your private key files). Need to use a java.io.File as JSch cant deal with vfs FileObjects ;-)
void	SftpFileSystemConfigBuilder.setKnownHosts(FileSystemOptions opts, File sshdir)	Set the known_hosts file.
void	SftpFileSystemConfigBuilder.setProxyHost(FileSystemOptions opts, String proxyHost)	Set the proxy to use for sftp connection. You have to set the ProxyPort too if you would like to have the proxy relly used.
void	SftpFileSystemConfigBuilder.setProxyPort(FileSystemOptions opts, int proxyPort)	Set the proxy-port to use for sftp connection You have to set the ProxyHost too if you would like to have the proxy relly used.
void	SftpFileSystemConfigBuilder.setProxyType(FileSystemOptions opts, SftpFileSystemConfigBuilder.ProxyType proxyType)	Set the proxy type to use for sftp connection.
void	SftpFileSystemConfigBuilder.setStrictHostKeyChecking(FileSystemOptions opts, String hostKeyChecking)	configure the host key checking to use. valid arguments are only yes, no and ask. See the jsch documentation for details.
void	SftpFileSystemConfigBuilder.setTimeout(FileSystemOptions opts, Integer timeout)	set the timeout value on jsch session
void	SftpFileSystemConfigBuilder.setUserDirIsRoot(FileSystemOptions opts, boolean userDirIsRoot)	use user directory as root (do not change to fs root)
void	SftpFileSystemConfigBuilder.setUserInfo(FileSystemOptions opts, com.jcraft.jsch.UserInfo info)	Set the userinfo class to use if e.g.

Constructors in org.apache.commons.vfs.provider.sftp with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	SftpFileSystem(GenericFileName rootName, com.jcraft.jsch.Session session, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.tar

Methods in org.apache.commons.vfs.provider.tar with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	TarFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs.provider.tar with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	TarFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.temp

Methods in org.apache.commons.vfs.provider.temp with parameters of type FileSystemOptions

Modifier and Type	Method	Description
FileObject	TemporaryFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions properties)	Locates a file object, by absolute URI.

Uses of FileSystemOptions in org.apache.commons.vfs.provider.url

Methods in org.apache.commons.vfs.provider.url with parameters of type FileSystemOptions

Modifier and Type	Method	Description
FileObject	UrlFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Constructors in org.apache.commons.vfs.provider.url with parameters of type FileSystemOptions

Modifier	Constructor	Description
protected	UrlFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.provider.zip

Methods in org.apache.commons.vfs.provider.zip with parameters of type FileSystemOptions

Modifier and Type	Method	Description
protected FileSystem	ZipFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs.provider.zip with parameters of type FileSystemOptions

Modifier	Constructor	Description
	ZipFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Uses of FileSystemOptions in org.apache.commons.vfs.util

Methods in org.apache.commons.vfs.util with parameters of type FileSystemOptions

Modifier and Type	Method	Description
static UserAuthenticationData	UserAuthenticatorUtils.authenticate(FileSystemOptions opts, UserAuthenticationData.Type[] authenticatorTypes)	if there is a authenticator the authentication will take place, else null will be reutrned
void	DelegatingFileSystemOptionsBuilder.setConfigClass(FileSystemOptions fso, String scheme, String name, Class className)	Set a single class value. The class has to implement a no-args constructor, else the instantiation might fail.
void	DelegatingFileSystemOptionsBuilder.setConfigClasses(FileSystemOptions fso, String scheme, String name, Class[] classNames)	Set an array of class values. The class has to implement a no-args constructor, else the instantiation might fail.
void	DelegatingFileSystemOptionsBuilder.setConfigString(FileSystemOptions fso, String scheme, String name, String value)	Set a single string value.
void	DelegatingFileSystemOptionsBuilder.setConfigStrings(FileSystemOptions fso, String scheme, String name, String[] values)	Set an array of string value.