Uses of Class
org.apache.commons.vfs.FileSystemOptions
Packages that use FileSystemOptions
Package
Description
The public VFS API.
The standard VFS implementation.
The File Provider API, and utility classes.
The FTP File Provider.
The Jar File Provider.
The Local File Provider.
The RAM File Provider.
The SFTP Provider.
The Tar File Provider.
The Temporary Filespace Provider.
The Default File Provider, which wraps java.net.URL.
The Zip File Provider.
Utility classes used by the VFS.
-
Uses of FileSystemOptions in org.apache.commons.vfs
Methods in org.apache.commons.vfs that return FileSystemOptionsModifier and TypeMethodDescriptionFileSystem.getFileSystemOptions()
Returns the FileSystemOptions used to instantiate this filesystemMethods in org.apache.commons.vfs with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionint
FileSystemOptions.compareTo
(FileSystemOptions other) protected Object
FileSystemConfigBuilder.getParam
(FileSystemOptions opts, String name) protected boolean
FileSystemConfigBuilder.hasParam
(FileSystemOptions opts, String name) 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 FileSystemOptionsModifier and TypeMethodDescriptionDefaultFileSystemConfigBuilder.getUserAuthenticator
(FileSystemOptions opts) DefaultFileSystemManager.resolveFile
(String uri, FileSystemOptions fileSystemOptions) Locate a file by URI, use the FileSystemOptions for file-system creationDefaultFileSystemManager.resolveFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Resolves a URI, realtive to a base file with specified FileSystem configurationvoid
DefaultFileSystemConfigBuilder.setUserAuthenticator
(FileSystemOptions opts, UserAuthenticator userAuthenticator) Sets the user authenticator to get authentication informationsConstructors in org.apache.commons.vfs.impl with parameters of type FileSystemOptionsModifierConstructorDescriptionVirtualFileSystem
(FileName rootName, FileSystemOptions fileSystemOptions) -
Uses of FileSystemOptions in org.apache.commons.vfs.provider
Methods in org.apache.commons.vfs.provider that return FileSystemOptionsModifier and TypeMethodDescriptionAbstractFileSystem.getFileSystemOptions()
Return the FileSystemOptions used to instantiate this filesystemMethods in org.apache.commons.vfs.provider with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionAbstractFileProvider.createFileSystem
(String scheme, FileObject file, FileSystemOptions properties) Creates a layered file system.AbstractLayeredFileProvider.createFileSystem
(String scheme, FileObject file, FileSystemOptions fileSystemOptions) Creates a layered file system.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 aFileSystem
.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.AbstractOriginatingFileProvider.findFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.CompositeFileProvider.findFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.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 systemVfsComponentContext.resolveFile
(String name, FileSystemOptions fileSystemOptions) Locate a file by name.VfsComponentContext.resolveFile
(FileObject baseFile, String name, FileSystemOptions fileSystemOptions) Locate a file by name.Constructors in org.apache.commons.vfs.provider with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
Bzip2FileProvider.createFileSystem
(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Constructors in org.apache.commons.vfs.provider.bzip2 with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected 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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionstatic 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.FtpFileSystemConfigBuilder.getDataTimeout
(FileSystemOptions opts) FtpFileSystemConfigBuilder.getDefaultDateFormat
(FileSystemOptions opts) get the language code used by the server.FtpFileSystemConfigBuilder.getEntryParser
(FileSystemOptions opts) org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
FtpFileSystemConfigBuilder.getEntryParserFactory
(FileSystemOptions opts) FtpFileSystemConfigBuilder.getPassiveMode
(FileSystemOptions opts) FtpFileSystemConfigBuilder.getRecentDateFormat
(FileSystemOptions opts) seeFTPClientConfig
for details and examples.FtpFileSystemConfigBuilder.getServerLanguageCode
(FileSystemOptions opts) get the language code used by the server.FtpFileSystemConfigBuilder.getServerTimeZoneId
(FileSystemOptions opts) seeFTPClientConfig
for details and examples.String[]
FtpFileSystemConfigBuilder.getShortMonthNames
(FileSystemOptions opts) seeFTPClientConfig
for details and examples.FtpFileSystemConfigBuilder.getUserDirIsRoot
(FileSystemOptions opts) void
FtpFileSystemConfigBuilder.setDataTimeout
(FileSystemOptions opts, Integer dataTimeout) set the data timeout for the ftp client.
If you set the dataTimeout tonull
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 parsingvoid
FtpFileSystemConfigBuilder.setPassiveMode
(FileSystemOptions opts, boolean passiveMode) enter into passive modevoid
FtpFileSystemConfigBuilder.setRecentDateFormat
(FileSystemOptions opts, String recentDateFormat) seeFTPClientConfig
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) seeFTPClientConfig
for details and examples.void
FtpFileSystemConfigBuilder.setShortMonthNames
(FileSystemOptions opts, String[] shortMonthNames) seeFTPClientConfig
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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
GzipFileProvider.createFileSystem
(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Constructors in org.apache.commons.vfs.provider.gzip with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionstatic 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 aFileSystem
.org.apache.commons.httpclient.Cookie[]
HttpFileSystemConfigBuilder.getCookies
(FileSystemOptions opts) The cookies to add to the reqestHttpFileSystemConfigBuilder.getProxyAuthenticator
(FileSystemOptions opts) Get the proxy authenticator where the system should get the credentials fromHttpFileSystemConfigBuilder.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.HttpFileSystemConfigBuilder.getUrlCharset
(FileSystemOptions opts) Set the charset used for url encodingvoid
HttpFileSystemConfigBuilder.setCookies
(FileSystemOptions opts, org.apache.commons.httpclient.Cookie[] cookies) The cookies to add to the reqestvoid
HttpFileSystemConfigBuilder.setProxyAuthenticator
(FileSystemOptions opts, UserAuthenticator authenticator) Set the proxy authenticator where the system should get the credentials fromvoid
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 encodingConstructors in org.apache.commons.vfs.provider.http with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected 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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
DefaultLocalFileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Creates the filesystem.Constructors in org.apache.commons.vfs.provider.local with parameters of type FileSystemOptionsModifierConstructorDescriptionLocalFileSystem
(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 FileSystemOptionsModifier and TypeMethodDescriptionprotected 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 systemConstructors in org.apache.commons.vfs.provider.ram with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionResourceFileProvider.findFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.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 FileSystemOptionsModifier and TypeMethodDescriptionstatic 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 aFileSystem
.SftpFileSystemConfigBuilder.getCompression
(FileSystemOptions opts) File[]
SftpFileSystemConfigBuilder.getIdentities
(FileSystemOptions opts) SftpFileSystemConfigBuilder.getKnownHosts
(FileSystemOptions opts) 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.getProxyType
(FileSystemOptions opts) Get the proxy type to use for sftp connection.SftpFileSystemConfigBuilder.getStrictHostKeyChecking
(FileSystemOptions opts) SftpFileSystemConfigBuilder.getTimeout
(FileSystemOptions opts) 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 sessionvoid
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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected 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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionTemporaryFileProvider.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 FileSystemOptionsModifier and TypeMethodDescriptionUrlFileProvider.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 FileSystemOptionsModifierConstructorDescriptionprotected
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 FileSystemOptionsModifier and TypeMethodDescriptionprotected 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 FileSystemOptionsModifierConstructorDescriptionZipFileSystem
(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 FileSystemOptionsModifier and TypeMethodDescriptionstatic UserAuthenticationData
UserAuthenticatorUtils.authenticate
(FileSystemOptions opts, UserAuthenticationData.Type[] authenticatorTypes) if there is a authenticator the authentication will take place, else null will be reutrnedvoid
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.