Uses of Class
org.apache.commons.vfs2.FileSystemOptions
Packages that use FileSystemOptions
Package
Description
The public VFS API.
The standard VFS implementation.
The File Provider API, and utility classes.
The BZIP2 File Provider.
The compressed file provider.
The FTP File Provider.
The FTPS File Provider.
The GZIP File Provider.
The HTTP File Provider.
The HTTP4 File Provider.
The HTTP5 File Provider.
The Jar File Provider.
The Local File Provider.
The RAM File Provider.
The Resource File Provider.
The SFTP Provider.
The Tar File Provider.
The Temporary Filespace Provider.
The Default File Provider, which wraps
URL
.The Zip File Provider.
Utility classes used by the VFS.
-
Uses of FileSystemOptions in org.apache.commons.vfs2
Methods in org.apache.commons.vfs2 that return FileSystemOptionsModifier and TypeMethodDescriptionFileSystem.getFileSystemOptions()
Returns the FileSystemOptions used to instantiate this file system.Methods in org.apache.commons.vfs2 with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionint
FileSystemOptions.compareTo
(FileSystemOptions other) protected Boolean
FileSystemConfigBuilder.getBoolean
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Boolean.protected boolean
FileSystemConfigBuilder.getBoolean
(FileSystemOptions fileSystemOptions, String name, boolean defaultValue) Gets a named option as a Boolean.protected Boolean
FileSystemConfigBuilder.getBoolean
(FileSystemOptions fileSystemOptions, String name, Boolean defaultValue) Gets a named option as a Boolean.protected Byte
FileSystemConfigBuilder.getByte
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Byte.protected byte
FileSystemConfigBuilder.getByte
(FileSystemOptions fileSystemOptions, String name, byte defaultValue) Gets a named option as a Byte.protected Byte
FileSystemConfigBuilder.getByte
(FileSystemOptions fileSystemOptions, String name, Byte defaultValue) Gets a named option as a Byte.protected Character
FileSystemConfigBuilder.getCharacter
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Character.protected char
FileSystemConfigBuilder.getCharacter
(FileSystemOptions fileSystemOptions, String name, char defaultValue) Gets a named option as a Character.protected Character
FileSystemConfigBuilder.getCharacter
(FileSystemOptions fileSystemOptions, String name, Character defaultValue) Gets a named option as a Character.protected Double
FileSystemConfigBuilder.getDouble
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Double.protected double
FileSystemConfigBuilder.getDouble
(FileSystemOptions fileSystemOptions, String name, double defaultValue) Gets a named option as a Double.protected Double
FileSystemConfigBuilder.getDouble
(FileSystemOptions fileSystemOptions, String name, Double defaultValue) Gets a named option as a Double.protected Duration
FileSystemConfigBuilder.getDuration
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Duration.protected Duration
FileSystemConfigBuilder.getDuration
(FileSystemOptions fileSystemOptions, String name, Duration defaultValue) Gets a named option as a Duration.protected Integer
FileSystemConfigBuilder.getDurationInteger
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Duration bound to the integer range.protected Integer
FileSystemConfigBuilder.getDurationInteger
(FileSystemOptions fileSystemOptions, String name, Duration defaultValue) Gets a named option as a Duration bound to the integer range.protected <E extends Enum<E>>
EFileSystemConfigBuilder.getEnum
(Class<E> enumClass, FileSystemOptions fileSystemOptions, String name) Gets a named option as a Double.protected <E extends Enum<E>>
EFileSystemConfigBuilder.getEnum
(Class<E> enumClass, FileSystemOptions fileSystemOptions, String name, E defaultValue) Gets a named option as an Enum.protected Float
FileSystemConfigBuilder.getFloat
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Float.protected float
FileSystemConfigBuilder.getFloat
(FileSystemOptions fileSystemOptions, String name, float defaultValue) Gets a named option as a Float.protected Float
FileSystemConfigBuilder.getFloat
(FileSystemOptions fileSystemOptions, String name, Float defaultValue) Gets a named option as a Float.protected Integer
FileSystemConfigBuilder.getInteger
(FileSystemOptions fileSystemOptions, String name) Gets a named option as an Integer.protected int
FileSystemConfigBuilder.getInteger
(FileSystemOptions fileSystemOptions, String name, int defaultValue) Gets a named option as an Integer.protected Integer
FileSystemConfigBuilder.getInteger
(FileSystemOptions fileSystemOptions, String name, Integer defaultValue) Gets a named option as an Integer.protected Long
FileSystemConfigBuilder.getLong
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Long.protected long
FileSystemConfigBuilder.getLong
(FileSystemOptions fileSystemOptions, String name, long defaultValue) Gets a named option as a Long.protected Long
FileSystemConfigBuilder.getLong
(FileSystemOptions fileSystemOptions, String name, Long defaultValue) Gets a named option as a Long.protected <T> T
FileSystemConfigBuilder.getParam
(FileSystemOptions fileSystemOptions, String name) Gets a named parameter.protected <T> T
FileSystemConfigBuilder.getParamOrDefault
(FileSystemOptions fileSystemOptions, String name, T defaultValue) Gets a named parameter.FileSystemConfigBuilder.getRootURI
(FileSystemOptions fileSystemOptions) Gets the root URI of the file system.protected Short
FileSystemConfigBuilder.getShort
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Short.protected short
FileSystemConfigBuilder.getShort
(FileSystemOptions fileSystemOptions, String name, short defaultValue) Gets a named option as a Short.protected Short
FileSystemConfigBuilder.getShort
(FileSystemOptions fileSystemOptions, String name, Short defaultValue) Gets a named option as a Short.protected String
FileSystemConfigBuilder.getString
(FileSystemOptions fileSystemOptions, String name) Gets a named option as a String.protected String
FileSystemConfigBuilder.getString
(FileSystemOptions fileSystemOptions, String name, String defaultValue) Gets a named option as a String.protected boolean
FileSystemConfigBuilder.hasObject
(FileSystemOptions fileSystemOptions, String name) Checks the named setting specified.protected boolean
FileSystemConfigBuilder.hasParam
(FileSystemOptions fileSystemOptions, String name) Checks if option exists.FileSystemManager.resolveFile
(String name, FileSystemOptions fileSystemOptions) Locates a file by name.protected void
FileSystemConfigBuilder.setParam
(FileSystemOptions fileSystemOptions, String name, boolean value) Sets the named parameter.protected void
FileSystemConfigBuilder.setParam
(FileSystemOptions fileSystemOptions, String name, Object value) Sets the named parameter.void
FileSystemConfigBuilder.setRootURI
(FileSystemOptions fileSystemOptions, String rootURI) Sets the root URI of the file system. -
Uses of FileSystemOptions in org.apache.commons.vfs2.impl
Methods in org.apache.commons.vfs2.impl with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionDefaultFileSystemConfigBuilder.getUserAuthenticator
(FileSystemOptions opts) Gets the UserAuthenticator parameter.DefaultFileSystemManager.resolveFile
(String uri, FileSystemOptions fileSystemOptions) Resolves a file by URI, use the FileSystemOptions for file-system creation.DefaultFileSystemManager.resolveFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Resolves a URI, relative to a base file with specified FileSystem configuration.void
DefaultFileSystemConfigBuilder.setUserAuthenticator
(FileSystemOptions opts, UserAuthenticator userAuthenticator) Sets the user authenticator to get authentication information.Constructors in org.apache.commons.vfs2.impl with parameters of type FileSystemOptionsModifierConstructorDescriptionVirtualFileSystem
(AbstractFileName rootFileName, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider
Methods in org.apache.commons.vfs2.provider that return FileSystemOptionsModifier and TypeMethodDescriptionAbstractFileSystem.getFileSystemOptions()
Gets the FileSystemOptions used to instantiate this file system.Methods in org.apache.commons.vfs2.provider with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionAbstractFileProvider.createFileSystem
(String scheme, FileObject file, FileSystemOptions fileSystemOptions) 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 rootFileName, FileSystemOptions fileSystemOptions) Creates aFileSystem
.AbstractLayeredFileProvider.findFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.protected FileObject
AbstractOriginatingFileProvider.findFile
(FileName fileName, FileSystemOptions fileSystemOptions) Locates a file from its parsed URI.AbstractOriginatingFileProvider.findFile
(FileObject baseFileObject, 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 fileSystemOptions) Locates a cached file system.protected FileSystem
AbstractOriginatingFileProvider.getFileSystem
(FileName rootFileName, FileSystemOptions fileSystemOptions) Returns the FileSystem associated with the specified root.VfsComponentContext.resolveFile
(String name, FileSystemOptions fileSystemOptions) Resolves a file by name.VfsComponentContext.resolveFile
(FileObject baseFile, String name, FileSystemOptions fileSystemOptions) Resolves a file by name.Constructors in org.apache.commons.vfs2.provider with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
AbstractFileSystem
(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance.DefaultURLStreamHandler
(VfsComponentContext context, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.bzip2
Methods in org.apache.commons.vfs2.provider.bzip2 with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
Bzip2FileProvider.createFileSystem
(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Constructors in org.apache.commons.vfs2.provider.bzip2 with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
Bzip2FileSystem
(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.compressed
Methods in org.apache.commons.vfs2.provider.compressed with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected abstract FileSystem
CompressedFileFileProvider.createFileSystem
(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Create a FileSystem.protected FileSystem
CompressedFileFileProvider.doCreateFileSystem
(String scheme, FileObject file, FileSystemOptions fileSystemOptions) Creates a layered file system.Constructors in org.apache.commons.vfs2.provider.compressed with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
CompressedFileFileSystem
(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.ftp
Fields in org.apache.commons.vfs2.provider.ftp declared as FileSystemOptionsModifier and TypeFieldDescriptionprotected final FileSystemOptions
FTPClientWrapper.fileSystemOptions
Authentication options.Methods in org.apache.commons.vfs2.provider.ftp that return FileSystemOptionsModifier and TypeMethodDescriptionFTPClientWrapper.getFileSystemOptions()
Gets the FileSystemOptions.Methods in org.apache.commons.vfs2.provider.ftp with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected abstract C
FtpClientFactory.ConnectionFactory.createClient
(FileSystemOptions fileSystemOptions) Creates a new client.protected org.apache.commons.net.ftp.FTPClient
FtpClientFactory.FtpConnectionFactory.createClient
(FileSystemOptions fileSystemOptions) FtpClientFactory.ConnectionFactory.createConnection
(String hostname, int port, char[] username, char[] password, String workingDirectory, FileSystemOptions fileSystemOptions) Creates a connection.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 file system.org.apache.commons.lang3.Range<Integer>
FtpFileSystemConfigBuilder.getActivePortRange
(FileSystemOptions options) Gets the active port range.FtpFileSystemConfigBuilder.getAutodetectUtf8
(FileSystemOptions options) Gets whether to try to autodetect the server encoding (only UTF8 is supported).FtpFileSystemConfigBuilder.getConnectTimeout
(FileSystemOptions options) Deprecated.FtpFileSystemConfigBuilder.getConnectTimeoutDuration
(FileSystemOptions options) Gets the timeout in milliseconds to use for the socket connection.FtpFileSystemConfigBuilder.getControlEncoding
(FileSystemOptions options) Gets the control encoding.FtpFileSystemConfigBuilder.getControlKeepAliveReplyTimeout
(FileSystemOptions options) Gets the controlKeepAliveReplyTimeout duration.FtpFileSystemConfigBuilder.getControlKeepAliveTimeout
(FileSystemOptions options) Gets the controlKeepAliveTimeout duration.FtpFileSystemConfigBuilder.getDataTimeout
(FileSystemOptions options) Deprecated.FtpFileSystemConfigBuilder.getDataTimeoutDuration
(FileSystemOptions options) Gets the timeout for opening the data channel.FtpFileSystemConfigBuilder.getDefaultDateFormat
(FileSystemOptions options) Gets the default date format used by the server.FtpFileSystemConfigBuilder.getEntryParser
(FileSystemOptions options) Gets the key to the EntryParser.org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
FtpFileSystemConfigBuilder.getEntryParserFactory
(FileSystemOptions options) Gets the FTPFileEntryParserFactory parameter.FtpFileSystemConfigBuilder.getFileType
(FileSystemOptions options) Gets the file type parameter.FtpFileSystemConfigBuilder.getMdtmLastModifiedTime
(FileSystemOptions options) Gets the option to use FTP MDTM forFileContent.getLastModifiedTime()
.FtpFileSystemConfigBuilder.getPassiveMode
(FileSystemOptions options) Tests whether passive mode is set.FtpFileSystemConfigBuilder.getProxy
(FileSystemOptions options) Gets the Proxy.FtpFileSystemConfigBuilder.getRecentDateFormat
(FileSystemOptions options) SeeFTPClientConfig
for details and examples.FtpFileSystemConfigBuilder.getRemoteVerification
(FileSystemOptions options) Gets whether to use remote verification.FtpFileSystemConfigBuilder.getServerLanguageCode
(FileSystemOptions options) Gets the language code used by the server.FtpFileSystemConfigBuilder.getServerTimeZoneId
(FileSystemOptions options) SeeFTPClientConfig
for details and examples.String[]
FtpFileSystemConfigBuilder.getShortMonthNames
(FileSystemOptions options) SeeFTPClientConfig
for details and examples.FtpFileSystemConfigBuilder.getSoTimeout
(FileSystemOptions options) Deprecated.FtpFileSystemConfigBuilder.getSoTimeoutDuration
(FileSystemOptions options) Gets The so timeout duration.FtpFileSystemConfigBuilder.getTransferAbortedOkReplyCodes
(FileSystemOptions options) Gets the list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.FtpFileSystemConfigBuilder.getUserDirIsRoot
(FileSystemOptions options) Tests whether if VFS should treat the user directory as the root directory.void
FtpFileSystemConfigBuilder.setActivePortRange
(FileSystemOptions options, org.apache.commons.lang3.Range<Integer> portRange) Sets the active port range.void
FtpFileSystemConfigBuilder.setAutodetectUtf8
(FileSystemOptions options, Boolean autodetectUTF8) Sets whether to try to autodetect the server encoding (only UTF8 is supported).void
FtpFileSystemConfigBuilder.setConnectTimeout
(FileSystemOptions options, Integer duration) void
FtpFileSystemConfigBuilder.setConnectTimeout
(FileSystemOptions options, Duration duration) Sets the timeout for the initial control connection.void
FtpFileSystemConfigBuilder.setControlEncoding
(FileSystemOptions options, String encoding) SeeFTP.setControlEncoding(java.lang.String)
for details and examples.void
FtpFileSystemConfigBuilder.setControlKeepAliveReplyTimeout
(FileSystemOptions options, Duration duration) Sets the control keep alive reply timeout for the FTP client.void
FtpFileSystemConfigBuilder.setControlKeepAliveTimeout
(FileSystemOptions options, Duration duration) Sets the control keep alive timeout for the FTP client.void
FtpFileSystemConfigBuilder.setDataTimeout
(FileSystemOptions options, Integer duration) void
FtpFileSystemConfigBuilder.setDataTimeout
(FileSystemOptions options, Duration duration) Sets the data timeout for the FTP client.void
FtpFileSystemConfigBuilder.setDefaultDateFormat
(FileSystemOptions options, String defaultDateFormat) Sets the default date format used by the server.void
FtpFileSystemConfigBuilder.setEntryParser
(FileSystemOptions options, String key) Sets the FQCN of your FileEntryParser used to parse the directory listing from your server.void
FtpFileSystemConfigBuilder.setEntryParserFactory
(FileSystemOptions options, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory) FTPFileEntryParserFactory which will be used for ftp-entry parsing.void
FtpFileSystemConfigBuilder.setFileType
(FileSystemOptions options, FtpFileType ftpFileType) Sets the file type parameter.void
FtpFileSystemConfigBuilder.setMdtmLastModifiedTime
(FileSystemOptions options, boolean mdtm) Sets the option to use FTP MDTM forFileContent.getLastModifiedTime()
.void
FtpFileSystemConfigBuilder.setPassiveMode
(FileSystemOptions options, boolean passiveMode) Enter into passive mode.void
FtpFileSystemConfigBuilder.setProxy
(FileSystemOptions options, Proxy proxy) Sets the Proxy.void
FtpFileSystemConfigBuilder.setRecentDateFormat
(FileSystemOptions options, String recentDateFormat) SeeFTPClientConfig
for details and examples.void
FtpFileSystemConfigBuilder.setRemoteVerification
(FileSystemOptions options, boolean remoteVerification) Sets whether to use remote verification.void
FtpFileSystemConfigBuilder.setServerLanguageCode
(FileSystemOptions options, String serverLanguageCode) Sets the language code used by the server.void
FtpFileSystemConfigBuilder.setServerTimeZoneId
(FileSystemOptions options, String serverTimeZoneId) SeeFTPClientConfig
for details and examples.void
FtpFileSystemConfigBuilder.setShortMonthNames
(FileSystemOptions options, String[] shortMonthNames) SeeFTPClientConfig
for details and examples.void
FtpFileSystemConfigBuilder.setSoTimeout
(FileSystemOptions options, Integer timeout) Deprecated.void
FtpFileSystemConfigBuilder.setSoTimeout
(FileSystemOptions options, Duration timeout) Sets the socket timeout for the FTP client.void
FtpFileSystemConfigBuilder.setTransferAbortedOkReplyCodes
(FileSystemOptions options, List<Integer> replyCodes) Sets the list of reply codes that are considered as OK when prematurely closing a stream.protected abstract void
FtpClientFactory.ConnectionFactory.setupOpenConnection
(C client, FileSystemOptions fileSystemOptions) Sets up a new client.protected void
FtpClientFactory.FtpConnectionFactory.setupOpenConnection
(org.apache.commons.net.ftp.FTPClient client, FileSystemOptions fileSystemOptions) void
FtpFileSystemConfigBuilder.setUserDirIsRoot
(FileSystemOptions options, boolean userDirIsRoot) Use user directory as root (do not change to fs root).Constructors in org.apache.commons.vfs2.provider.ftp with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
FTPClientWrapper
(GenericFileName rootFileName, FileSystemOptions fileSystemOptions) Constructs a new instance.FtpFileSystem
(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.ftps
Methods in org.apache.commons.vfs2.provider.ftps with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionstatic org.apache.commons.net.ftp.FTPSClient
FtpsClientFactory.createConnection
(String hostname, int port, char[] username, char[] password, String workingDirectory, FileSystemOptions fileSystemOptions) Creates a new connection to the server.protected FileSystem
FtpsFileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Creates the file system.FtpsFileSystemConfigBuilder.getDataChannelProtectionLevel
(FileSystemOptions opts) Gets the data channel protection level (PROT).FtpsFileSystemConfigBuilder.getFtpsMode
(FileSystemOptions opts) Returns the FTPS mode.FtpsFileSystemConfigBuilder.getFtpsType
(FileSystemOptions opts) Deprecated.As of 2.1, useFtpsFileSystemConfigBuilder.getFtpsMode(FileSystemOptions)
FtpsFileSystemConfigBuilder.getKeyManager
(FileSystemOptions opts) Gets the KeyManager used to provide a client-side certificate if the FTPS server requests it.FtpsFileSystemConfigBuilder.getTrustManager
(FileSystemOptions opts) Gets the TrustManager that validates the FTPS server's certificate.void
FtpsFileSystemConfigBuilder.setDataChannelProtectionLevel
(FileSystemOptions opts, FtpsDataChannelProtectionLevel prot) Sets the data channel protection level (PROT).void
FtpsFileSystemConfigBuilder.setFtpsMode
(FileSystemOptions opts, FtpsMode ftpsMode) Sets FTPS mode, either "implicit" or "explicit".void
FtpsFileSystemConfigBuilder.setFtpsType
(FileSystemOptions opts, String ftpsType) Deprecated.void
FtpsFileSystemConfigBuilder.setKeyManager
(FileSystemOptions opts, KeyManager keyManager) Sets the KeyManager used to provide a client-side certificate if the FTPS server requests it.void
FtpsFileSystemConfigBuilder.setTrustManager
(FileSystemOptions opts, TrustManager trustManager) Sets the TrustManager that validates the FTPS server's certificate.Constructors in org.apache.commons.vfs2.provider.ftps with parameters of type FileSystemOptionsModifierConstructorDescriptionFtpsFileSystem
(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions) Creates a new FtpsFileSystem. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.gzip
Methods in org.apache.commons.vfs2.provider.gzip with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
GzipFileProvider.createFileSystem
(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Constructors in org.apache.commons.vfs2.provider.gzip with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
GzipFileSystem
(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.http
Methods in org.apache.commons.vfs2.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) Deprecated.Creates an HttpClient.static org.apache.commons.httpclient.HttpClient
HttpClientFactory.createConnection
(HttpFileSystemConfigBuilder builder, String scheme, String hostname, int port, String username, String password, FileSystemOptions fileSystemOptions) Deprecated.Creates a new connection to the server.protected FileSystem
HttpFileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Deprecated.Creates aFileSystem
.int
HttpFileSystemConfigBuilder.getConnectionTimeout
(FileSystemOptions opts) HttpFileSystemConfigBuilder.getConnectionTimeoutDuration
(FileSystemOptions opts) Deprecated.Gets the connection timeout.org.apache.commons.httpclient.Cookie[]
HttpFileSystemConfigBuilder.getCookies
(FileSystemOptions opts) Deprecated.Gets the cookies to add to the request.boolean
HttpFileSystemConfigBuilder.getFollowRedirect
(FileSystemOptions opts) Deprecated.Gets whether to follow redirects for the connection.int
HttpFileSystemConfigBuilder.getMaxConnectionsPerHost
(FileSystemOptions opts) Deprecated.Gets the maximum number of connections allowed per host.int
HttpFileSystemConfigBuilder.getMaxTotalConnections
(FileSystemOptions opts) Deprecated.Gets the maximum number of connections allowed.HttpFileSystemConfigBuilder.getProxyAuthenticator
(FileSystemOptions opts) Deprecated.Gets the proxy authenticator where the system should get the credentials from.HttpFileSystemConfigBuilder.getProxyHost
(FileSystemOptions opts) Deprecated.Gets the proxy to use for http connection.int
HttpFileSystemConfigBuilder.getProxyPort
(FileSystemOptions opts) Deprecated.Gets the proxy-port to use for http the connection.int
HttpFileSystemConfigBuilder.getSoTimeout
(FileSystemOptions opts) Deprecated.HttpFileSystemConfigBuilder.getSoTimeoutDuration
(FileSystemOptions opts) Deprecated.Gets the socket timeout.HttpFileSystemConfigBuilder.getUrlCharset
(FileSystemOptions opts) Deprecated.Gets the charset used for url encoding.HttpFileSystemConfigBuilder.getUserAgent
(FileSystemOptions opts) Deprecated.Gets the user agent string.boolean
HttpFileSystemConfigBuilder.isPreemptiveAuth
(FileSystemOptions opts) Deprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.void
HttpFileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, int timeout) void
HttpFileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, Duration timeout) Deprecated.The connection timeout.void
HttpFileSystemConfigBuilder.setCookies
(FileSystemOptions opts, org.apache.commons.httpclient.Cookie[] cookies) Deprecated.The cookies to add to the request.void
HttpFileSystemConfigBuilder.setFollowRedirect
(FileSystemOptions opts, boolean redirect) Deprecated.Sets whether to follow redirects for the connection.void
HttpFileSystemConfigBuilder.setMaxConnectionsPerHost
(FileSystemOptions opts, int maxHostConnections) Deprecated.Sets the maximum number of connections allowed to any host.void
HttpFileSystemConfigBuilder.setMaxTotalConnections
(FileSystemOptions opts, int maxTotalConnections) Deprecated.Sets the maximum number of connections allowed.void
HttpFileSystemConfigBuilder.setPreemptiveAuth
(FileSystemOptions opts, boolean preemptiveAuth) Deprecated.Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.void
HttpFileSystemConfigBuilder.setProxyAuthenticator
(FileSystemOptions opts, UserAuthenticator authenticator) Deprecated.Sets the proxy authenticator where the system should get the credentials from.void
HttpFileSystemConfigBuilder.setProxyHost
(FileSystemOptions opts, String proxyHost) Deprecated.Sets the proxy to use for http connection.void
HttpFileSystemConfigBuilder.setProxyPort
(FileSystemOptions opts, int proxyPort) Deprecated.Sets the proxy-port to use for http connection.void
HttpFileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, int timeout) void
HttpFileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, Duration timeout) Deprecated.The socket timeout.void
HttpFileSystemConfigBuilder.setUrlCharset
(FileSystemOptions opts, String charset) Deprecated.Sets the charset used for url encoding.void
HttpFileSystemConfigBuilder.setUserAgent
(FileSystemOptions opts, String userAgent) Deprecated.Sets the user agent to attach to the outgoing http methods.Constructors in org.apache.commons.vfs2.provider.http with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
HttpFileSystem
(GenericFileName rootName, org.apache.commons.httpclient.HttpClient httpClient, FileSystemOptions fileSystemOptions) Deprecated.Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.http4
Methods in org.apache.commons.vfs2.provider.http4 with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected org.apache.http.client.HttpClient
Http4FileProvider.createHttpClient
(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Deprecated.Create anHttpClient
object for an http4 file system.protected org.apache.http.impl.client.HttpClientBuilder
Http4FileProvider.createHttpClientBuilder
(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Deprecated.Create anHttpClientBuilder
object.protected org.apache.http.client.protocol.HttpClientContext
Http4FileProvider.createHttpClientContext
(Http4FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions, UserAuthenticationData authData) Deprecated.Create anHttpClientContext
object for an http4 file system.protected SSLContext
Http4FileProvider.createSSLContext
(Http4FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions) Deprecated.CreateSSLContext
for HttpClient.protected FileSystem
Http4FileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Deprecated.int
Http4FileSystemConfigBuilder.getConnectionTimeout
(FileSystemOptions opts) Http4FileSystemConfigBuilder.getConnectionTimeoutDuration
(FileSystemOptions opts) Deprecated./** Gets the connection timeout.org.apache.http.cookie.Cookie[]
Http4FileSystemConfigBuilder.getCookies
(FileSystemOptions opts) Deprecated.Gets the cookies to add to the request.boolean
Http4FileSystemConfigBuilder.getFollowRedirect
(FileSystemOptions opts) Deprecated.Gets whether to follow redirects for the connection.Http4FileSystemConfigBuilder.getKeyStoreFile
(FileSystemOptions opts) Deprecated.Gets keystore file path to be used in SSL connections.Http4FileSystemConfigBuilder.getKeyStoreType
(FileSystemOptions opts) Deprecated.Gets keystore type for SSL connections.int
Http4FileSystemConfigBuilder.getMaxConnectionsPerHost
(FileSystemOptions opts) Deprecated.Gets the maximum number of connections allowed per host.int
Http4FileSystemConfigBuilder.getMaxTotalConnections
(FileSystemOptions opts) Deprecated.Gets the maximum number of connections allowed.Http4FileSystemConfigBuilder.getProxyAuthenticator
(FileSystemOptions opts) Deprecated.Gets the proxy authenticator where the system should get the credentials from.Http4FileSystemConfigBuilder.getProxyHost
(FileSystemOptions opts) Deprecated.Gets the proxy to use for http connection.int
Http4FileSystemConfigBuilder.getProxyPort
(FileSystemOptions opts) Deprecated.Gets the proxy-port to use for http the connection.Http4FileSystemConfigBuilder.getProxyScheme
(FileSystemOptions opts) Deprecated.Gets the proxy-scheme to use for http the connection.int
Http4FileSystemConfigBuilder.getSoTimeout
(FileSystemOptions opts) Deprecated.Http4FileSystemConfigBuilder.getSoTimeoutDuration
(FileSystemOptions opts) Deprecated.Gets the socket timeout.Http4FileSystemConfigBuilder.getUrlCharset
(FileSystemOptions opts) Deprecated.Sets the charset used for url encoding.Http4FileSystemConfigBuilder.getUserAgent
(FileSystemOptions opts) Deprecated.Gets the user agent string.boolean
Http4FileSystemConfigBuilder.isHostnameVerificationEnabled
(FileSystemOptions opts) Deprecated.Determines if the hostname should be verified in SSL context.boolean
Http4FileSystemConfigBuilder.isKeepAlive
(FileSystemOptions opts) Deprecated.Determines if the FileSystemOptions indicate that HTTP Keep-Alive is respected.boolean
Http4FileSystemConfigBuilder.isPreemptiveAuth
(FileSystemOptions opts) Deprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.void
Http4FileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, int connectionTimeout) void
Http4FileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, Duration connectionTimeout) Deprecated.Sets the connection timeout.void
Http4FileSystemConfigBuilder.setCookies
(FileSystemOptions opts, org.apache.http.cookie.Cookie[] cookies) Deprecated.The cookies to add to the request.void
Http4FileSystemConfigBuilder.setFollowRedirect
(FileSystemOptions opts, boolean redirect) Deprecated.Sets whether to follow redirects for the connection.void
Http4FileSystemConfigBuilder.setHostnameVerificationEnabled
(FileSystemOptions opts, boolean hostnameVerificationEnabled) Deprecated.Sets if the hostname should be verified in SSL context.void
Http4FileSystemConfigBuilder.setKeepAlive
(FileSystemOptions opts, boolean keepAlive) Deprecated.Sets if the FileSystemOptions indicate that HTTP Keep-Alive is respected.void
Http4FileSystemConfigBuilder.setKeyStoreFile
(FileSystemOptions opts, String keyStoreFile) Deprecated.Sets keystore file path for SSL connections.void
Http4FileSystemConfigBuilder.setKeyStorePass
(FileSystemOptions opts, String keyStorePass) Deprecated.Sets keystore pass phrase for SSL connections.void
Http4FileSystemConfigBuilder.setKeyStoreType
(FileSystemOptions opts, String keyStoreType) Deprecated.Sets keystore type for SSL connections.void
Http4FileSystemConfigBuilder.setMaxConnectionsPerHost
(FileSystemOptions opts, int maxHostConnections) Deprecated.Sets the maximum number of connections allowed to any host.void
Http4FileSystemConfigBuilder.setMaxTotalConnections
(FileSystemOptions opts, int maxTotalConnections) Deprecated.Sets the maximum number of connections allowed.void
Http4FileSystemConfigBuilder.setPreemptiveAuth
(FileSystemOptions opts, boolean preemptiveAuth) Deprecated.Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.void
Http4FileSystemConfigBuilder.setProxyAuthenticator
(FileSystemOptions opts, UserAuthenticator authenticator) Deprecated.Sets the proxy authenticator where the system should get the credentials from.void
Http4FileSystemConfigBuilder.setProxyHost
(FileSystemOptions opts, String proxyHost) Deprecated.Sets the proxy to use for http connection.void
Http4FileSystemConfigBuilder.setProxyPort
(FileSystemOptions opts, int proxyPort) Deprecated.Sets the proxy-port to use for http connection.void
Http4FileSystemConfigBuilder.setProxyScheme
(FileSystemOptions opts, String proxyScheme) Deprecated.Sets the proxy-scheme to use for http connection.void
Http4FileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, int soTimeout) void
Http4FileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, Duration soTimeout) Deprecated.Sets the socket timeout.void
Http4FileSystemConfigBuilder.setUrlCharset
(FileSystemOptions opts, String charset) Deprecated.Sets the charset used for URL encoding.void
Http4FileSystemConfigBuilder.setUserAgent
(FileSystemOptions opts, String userAgent) Deprecated.Sets the user agent to attach to the outgoing http methods.Constructors in org.apache.commons.vfs2.provider.http4 with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
Http4FileSystem
(FileName rootName, FileSystemOptions fileSystemOptions, org.apache.http.client.HttpClient httpClient, org.apache.http.client.protocol.HttpClientContext httpClientContext) Deprecated.Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.http5
Methods in org.apache.commons.vfs2.provider.http5 with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected org.apache.hc.client5.http.classic.HttpClient
Http5FileProvider.createHttpClient
(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Create anHttpClient
object for an http4 file system.protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder
Http5FileProvider.createHttpClientBuilder
(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions) Create anHttpClientBuilder
object.protected org.apache.hc.client5.http.protocol.HttpClientContext
Http5FileProvider.createHttpClientContext
(Http5FileSystemConfigBuilder builder, GenericFileName rootName, FileSystemOptions fileSystemOptions, UserAuthenticationData authData) Create anHttpClientContext
object for an http4 file system.protected SSLContext
Http5FileProvider.createSSLContext
(Http5FileSystemConfigBuilder builder, FileSystemOptions fileSystemOptions) CreateSSLContext
for HttpClient.protected FileSystem
Http5FileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) int
Http5FileSystemConfigBuilder.getConnectionTimeout
(FileSystemOptions opts) Http5FileSystemConfigBuilder.getConnectionTimeoutDuration
(FileSystemOptions opts) Gets the connection timeout.org.apache.hc.client5.http.cookie.Cookie[]
Http5FileSystemConfigBuilder.getCookies
(FileSystemOptions opts) Gets the cookies to add to the request.boolean
Http5FileSystemConfigBuilder.getFollowRedirect
(FileSystemOptions opts) Gets whether to follow redirects for the connection.Http5FileSystemConfigBuilder.getKeyStoreFile
(FileSystemOptions opts) Gets keystore file path to be used in SSL connections.Http5FileSystemConfigBuilder.getKeyStoreType
(FileSystemOptions opts) Gets keystore type for SSL connections.int
Http5FileSystemConfigBuilder.getMaxConnectionsPerHost
(FileSystemOptions opts) Gets the maximum number of connections allowed per host.int
Http5FileSystemConfigBuilder.getMaxTotalConnections
(FileSystemOptions opts) Gets the maximum number of connections allowed.Http5FileSystemConfigBuilder.getProxyAuthenticator
(FileSystemOptions opts) Gets the proxy authenticator where the system should get the credentials from.Http5FileSystemConfigBuilder.getProxyHost
(FileSystemOptions opts) Gets the proxy to use for http connection.int
Http5FileSystemConfigBuilder.getProxyPort
(FileSystemOptions opts) Gets the proxy-port to use for http the connection.Http5FileSystemConfigBuilder.getProxyScheme
(FileSystemOptions opts) Gets the proxy-scheme to use for http the connection.int
Http5FileSystemConfigBuilder.getSoTimeout
(FileSystemOptions opts) Deprecated.Http5FileSystemConfigBuilder.getSoTimeoutDuration
(FileSystemOptions opts) Gets the socket timeout.Http5FileSystemConfigBuilder.getTlsVersions
(FileSystemOptions opts) Gets the enabled TLS versions as a comma separated string, each token of which is the name oforg.apache.hc.core5.http.ssl.TLS
enum. e.g, "V_1_2, V_1_3".Http5FileSystemConfigBuilder.getUrlCharset
(FileSystemOptions opts) Gets the charset used for url encoding.Http5FileSystemConfigBuilder.getUserAgent
(FileSystemOptions opts) Gets the user agent string.boolean
Http5FileSystemConfigBuilder.isHostnameVerificationEnabled
(FileSystemOptions opts) Determines if the hostname should be verified in SSL context.boolean
Http5FileSystemConfigBuilder.isKeepAlive
(FileSystemOptions opts) Determines if the FileSystemOptions indicate that HTTP Keep-Alive is respected.boolean
Http5FileSystemConfigBuilder.isPreemptiveAuth
(FileSystemOptions opts) Determines if the FileSystemOptions indicate that preemptive authentication is requested.void
Http5FileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, int connectionTimeout) void
Http5FileSystemConfigBuilder.setConnectionTimeout
(FileSystemOptions opts, Duration connectionTimeout) Sets the connection timeout.void
Http5FileSystemConfigBuilder.setCookies
(FileSystemOptions opts, org.apache.hc.client5.http.cookie.Cookie[] cookies) The cookies to add to the request.void
Http5FileSystemConfigBuilder.setFollowRedirect
(FileSystemOptions opts, boolean redirect) Sets whether to follow redirects for the connection.void
Http5FileSystemConfigBuilder.setHostnameVerificationEnabled
(FileSystemOptions opts, boolean hostnameVerificationEnabled) Sets if the hostname should be verified in SSL context.void
Http5FileSystemConfigBuilder.setKeepAlive
(FileSystemOptions opts, boolean keepAlive) Sets if the FileSystemOptions indicate that HTTP Keep-Alive is respected.void
Http5FileSystemConfigBuilder.setKeyStoreFile
(FileSystemOptions opts, String keyStoreFile) Sets keystore file path for SSL connections.void
Http5FileSystemConfigBuilder.setKeyStorePass
(FileSystemOptions opts, String keyStorePass) Sets keystore pass phrase for SSL connections.void
Http5FileSystemConfigBuilder.setKeyStoreType
(FileSystemOptions opts, String keyStoreType) Sets keystore type for SSL connections.void
Http5FileSystemConfigBuilder.setMaxConnectionsPerHost
(FileSystemOptions opts, int maxHostConnections) Sets the maximum number of connections allowed to any host.void
Http5FileSystemConfigBuilder.setMaxTotalConnections
(FileSystemOptions opts, int maxTotalConnections) Sets the maximum number of connections allowed.void
Http5FileSystemConfigBuilder.setPreemptiveAuth
(FileSystemOptions opts, boolean preemptiveAuth) Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.void
Http5FileSystemConfigBuilder.setProxyAuthenticator
(FileSystemOptions opts, UserAuthenticator authenticator) Sets the proxy authenticator where the system should get the credentials from.void
Http5FileSystemConfigBuilder.setProxyHost
(FileSystemOptions opts, String proxyHost) Sets the proxy to use for http connection.void
Http5FileSystemConfigBuilder.setProxyPort
(FileSystemOptions opts, int proxyPort) Sets the proxy-port to use for http connection.void
Http5FileSystemConfigBuilder.setProxyScheme
(FileSystemOptions opts, String proxyScheme) Sets the proxy-scheme to use for http connection.void
Http5FileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, int soTimeout) void
Http5FileSystemConfigBuilder.setSoTimeout
(FileSystemOptions opts, Duration soTimeout) The socket timeout.void
Http5FileSystemConfigBuilder.setTlsVersions
(FileSystemOptions opts, String tlsVersions) Sets the enabled TLS versions as a comma separated string, each token of which is the name oforg.apache.hc.core5.http.ssl.TLS
enum. e.g, "V_1_2, V_1_3".void
Http5FileSystemConfigBuilder.setUrlCharset
(FileSystemOptions opts, String charset) Sets the charset used for url encoding.void
Http5FileSystemConfigBuilder.setUserAgent
(FileSystemOptions opts, String userAgent) Sets the user agent to attach to the outgoing http methods.Constructors in org.apache.commons.vfs2.provider.http5 with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
Http5FileSystem
(FileName rootName, FileSystemOptions fileSystemOptions, org.apache.hc.client5.http.classic.HttpClient httpClient, org.apache.hc.client5.http.protocol.HttpClientContext httpClientContext) ConstructsHttp4FileSystem
. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.jar
Methods in org.apache.commons.vfs2.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.vfs2.provider.jar with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
JarFileSystem
(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.local
Methods in org.apache.commons.vfs2.provider.local with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
DefaultLocalFileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Creates the file system.Constructors in org.apache.commons.vfs2.provider.local with parameters of type FileSystemOptionsModifierConstructorDescriptionLocalFileSystem
(FileName rootFileName, String rootFile, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.ram
Methods in org.apache.commons.vfs2.provider.ram with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
RamFileProvider.doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) long
RamFileSystemConfigBuilder.getLongMaxSize
(FileSystemOptions opts) Defaults toInteger.MAX_VALUE
.int
RamFileSystemConfigBuilder.getMaxSize
(FileSystemOptions opts) Defaults toInteger.MAX_VALUE
.void
RamFileSystemConfigBuilder.setMaxSize
(FileSystemOptions opts, int sizeInBytes) Deprecated.void
RamFileSystemConfigBuilder.setMaxSize
(FileSystemOptions opts, long sizeInBytes) Sets the maximum size of the file system.Constructors in org.apache.commons.vfs2.provider.ram with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
RamFileSystem
(FileName rootName, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.res
Methods in org.apache.commons.vfs2.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 fileSystemOptions) Gets the class loader from the FileSystemOptions.void
ResourceFileSystemConfigBuilder.setClassLoader
(FileSystemOptions fileSystemOptions, ClassLoader classLoader) Sets the class loader in the FileSystemOptions. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.sftp
Methods in org.apache.commons.vfs2.provider.sftp that return FileSystemOptionsModifier and TypeMethodDescriptionSftpFileSystemConfigBuilder.getProxyOptions
(FileSystemOptions options) Gets the proxy options that are used to connect to the proxy host.Methods in org.apache.commons.vfs2.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 options) Gets the names of the compression algorithms, comma-separated.com.jcraft.jsch.ConfigRepository
SftpFileSystemConfigBuilder.getConfigRepository
(FileSystemOptions options) Gets the config repository.SftpFileSystemConfigBuilder.getConnectTimeout
(FileSystemOptions options) Gets the connect timeout duration.SftpFileSystemConfigBuilder.getConnectTimeoutMillis
(FileSystemOptions options) Deprecated.SftpFileSystemConfigBuilder.getFileNameEncoding
(FileSystemOptions options) Gets the file name encoding.File[]
SftpFileSystemConfigBuilder.getIdentities
(FileSystemOptions options) Deprecated.SftpFileSystemConfigBuilder.getIdentityInfo
(FileSystemOptions options) Gets the identity infos.SftpFileSystemConfigBuilder.getIdentityProvider
(FileSystemOptions options) Gets the identity providers.SftpFileSystemConfigBuilder.getIdentityRepositoryFactory
(FileSystemOptions options) Gets the identity repository factory.SftpFileSystemConfigBuilder.getKeyExchangeAlgorithm
(FileSystemOptions options) Gets the option value for specific key exchange algorithm.SftpFileSystemConfigBuilder.getKnownHosts
(FileSystemOptions options) Gets the known hosts File.SftpFileSystemConfigBuilder.getPreferredAuthentications
(FileSystemOptions options) Gets authentication order.SftpFileSystemConfigBuilder.getProxyCommand
(FileSystemOptions options) Gets the command that will be run on the proxy host when using a SftpStreamProxy.SftpFileSystemConfigBuilder.getProxyHost
(FileSystemOptions options) Gets the proxy to use for the SFTP connection.SftpFileSystemConfigBuilder.getProxyOptions
(FileSystemOptions options) Gets the proxy options that are used to connect to the proxy host.SftpFileSystemConfigBuilder.getProxyPassword
(FileSystemOptions options) Gets the proxy password that are used to connect to the proxy host.int
SftpFileSystemConfigBuilder.getProxyPort
(FileSystemOptions options) Gets the proxy-port to use for the SFTP the connection.SftpFileSystemConfigBuilder.getProxyType
(FileSystemOptions options) Gets the proxy type to use for the SFTP connection.SftpFileSystemConfigBuilder.getProxyUser
(FileSystemOptions options) Gets the user name for the proxy used for the SFTP connection.SftpFileSystemConfigBuilder.getSessionTimeout
(FileSystemOptions options) Gets the session timeout value in milliseconds.SftpFileSystemConfigBuilder.getSessionTimeoutMillis
(FileSystemOptions options) Deprecated.SftpFileSystemConfigBuilder.getStrictHostKeyChecking
(FileSystemOptions options) Gets the option value The host key checking.SftpFileSystemConfigBuilder.getTimeout
(FileSystemOptions options) SftpFileSystemConfigBuilder.getUserDirIsRoot
(FileSystemOptions options) GetsBoolean.TRUE
if VFS should treat the user directory as the root directory.com.jcraft.jsch.UserInfo
SftpFileSystemConfigBuilder.getUserInfo
(FileSystemOptions options) Gets the UserInfo.boolean
SftpFileSystemConfigBuilder.isDisableDetectExecChannel
(FileSystemOptions options) Returnstrue
if the detection of the exec channel should be disabled.boolean
SftpFileSystemConfigBuilder.isLoadOpenSSHConfig
(FileSystemOptions options) ReturnsBoolean.TRUE
if VFS should load the OpenSSH config.void
SftpFileSystemConfigBuilder.setCompression
(FileSystemOptions options, String compression) Configures the compression algorithms to use.void
SftpFileSystemConfigBuilder.setConfigRepository
(FileSystemOptions options, com.jcraft.jsch.ConfigRepository configRepository) Sets the config repository. e.g.void
SftpFileSystemConfigBuilder.setConnectTimeout
(FileSystemOptions options, Duration timeout) Sets the timeout value to create a Jsch connection.void
SftpFileSystemConfigBuilder.setConnectTimeoutMillis
(FileSystemOptions options, Integer timeout) void
SftpFileSystemConfigBuilder.setDisableDetectExecChannel
(FileSystemOptions options, boolean disableDetectExecChannel) Sets whether detection of exec channel is disabled.void
SftpFileSystemConfigBuilder.setFileNameEncoding
(FileSystemOptions options, String fileNameEncoding) Sets the file name encoding.void
SftpFileSystemConfigBuilder.setIdentities
(FileSystemOptions options, File... identityFiles) Deprecated.void
SftpFileSystemConfigBuilder.setIdentityInfo
(FileSystemOptions options, IdentityInfo... identities) void
SftpFileSystemConfigBuilder.setIdentityProvider
(FileSystemOptions options, IdentityProvider... identities) Sets the identity info (your private key files).void
SftpFileSystemConfigBuilder.setIdentityRepositoryFactory
(FileSystemOptions options, IdentityRepositoryFactory factory) Sets the identity repository.void
SftpFileSystemConfigBuilder.setKeyExchangeAlgorithm
(FileSystemOptions options, String keyExchangeAlgorithm) Configures Key exchange algorithm explicitly e.g. diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1.void
SftpFileSystemConfigBuilder.setKnownHosts
(FileSystemOptions options, File knownHosts) Sets the known_hosts file. e.g.void
SftpFileSystemConfigBuilder.setLoadOpenSSHConfig
(FileSystemOptions options, boolean loadOpenSSHConfig) Sets the whether to load OpenSSH config.void
SftpFileSystemConfigBuilder.setPreferredAuthentications
(FileSystemOptions options, String preferredAuthentications) Configures authentication order.void
SftpFileSystemConfigBuilder.setProxyCommand
(FileSystemOptions options, String proxyCommand) Sets the proxy username to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyHost
(FileSystemOptions options, String proxyHost) Sets the proxy to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyOptions
(FileSystemOptions options, FileSystemOptions proxyOptions) Sets the proxy username to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyPassword
(FileSystemOptions options, String proxyPassword) Sets the proxy password to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyPort
(FileSystemOptions options, int proxyPort) Sets the proxy port to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyType
(FileSystemOptions options, SftpFileSystemConfigBuilder.ProxyType proxyType) Sets the proxy type to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setProxyUser
(FileSystemOptions options, String proxyUser) Sets the proxy username to use for the SFTP connection.void
SftpFileSystemConfigBuilder.setSessionTimeout
(FileSystemOptions options, Duration timeout) Sets the timeout value on Jsch session.void
SftpFileSystemConfigBuilder.setSessionTimeoutMillis
(FileSystemOptions options, Integer timeout) void
SftpFileSystemConfigBuilder.setStrictHostKeyChecking
(FileSystemOptions options, String hostKeyChecking) Configures the host key checking to use.void
SftpFileSystemConfigBuilder.setTimeout
(FileSystemOptions options, Integer timeout) void
SftpFileSystemConfigBuilder.setUserDirIsRoot
(FileSystemOptions options, boolean userDirIsRoot) Sets the whether to use the user directory as root (do not change to file system root).void
SftpFileSystemConfigBuilder.setUserInfo
(FileSystemOptions options, com.jcraft.jsch.UserInfo info) Sets the Jsch UserInfo class to use.Constructors in org.apache.commons.vfs2.provider.sftp with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
SftpFileSystem
(GenericFileName rootName, com.jcraft.jsch.Session session, FileSystemOptions fileSystemOptions) Constructs a new instance.SftpStreamProxy
(String commandFormat, String proxyUser, String proxyHost, int proxyPort, String proxyPassword, FileSystemOptions proxyOptions) Creates a stream proxy. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.tar
Methods in org.apache.commons.vfs2.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.vfs2.provider.tar with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
TarFileSystem
(AbstractFileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.temp
Methods in org.apache.commons.vfs2.provider.temp with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionTemporaryFileProvider.findFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.url
Methods in org.apache.commons.vfs2.provider.url with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionUrlFileProvider.findFile
(FileObject baseFile, String fileUri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.Constructors in org.apache.commons.vfs2.provider.url with parameters of type FileSystemOptionsModifierConstructorDescriptionprotected
UrlFileSystem
(FileName rootName, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.provider.zip
Methods in org.apache.commons.vfs2.provider.zip with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionprotected FileSystem
ZipFileProvider.doCreateFileSystem
(String scheme, FileObject file, FileSystemOptions fileSystemOptions) Creates a layered file system.ZipFileSystemConfigBuilder.getCharset
(FileSystemOptions fileSystemOptions) Gets the Charset from the FileSystemOptions orStandardCharsets.UTF_8
if absent.void
ZipFileSystemConfigBuilder.setCharset
(FileSystemOptions fileSystemOptions, Charset charset) Sets the Charset in the FileSystemOptions.Constructors in org.apache.commons.vfs2.provider.zip with parameters of type FileSystemOptionsModifierConstructorDescriptionZipFileSystem
(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Uses of FileSystemOptions in org.apache.commons.vfs2.util
Methods in org.apache.commons.vfs2.util with parameters of type FileSystemOptionsModifier and TypeMethodDescriptionstatic UserAuthenticationData
UserAuthenticatorUtils.authenticate
(FileSystemOptions options, UserAuthenticationData.Type[] authenticatorTypes) Authenticates if there is an authenticator, else returns null.void
DelegatingFileSystemOptionsBuilder.setConfigClass
(FileSystemOptions fso, String scheme, String name, Class<?> className) Sets a single class value.void
DelegatingFileSystemOptionsBuilder.setConfigClasses
(FileSystemOptions fso, String scheme, String name, Class<?>[] classNames) Sets an array of class values.void
DelegatingFileSystemOptionsBuilder.setConfigString
(FileSystemOptions fso, String scheme, String name, String value) Sets a single string value.void
DelegatingFileSystemOptionsBuilder.setConfigStrings
(FileSystemOptions fso, String scheme, String name, String[] values) Sets an array of string value.
FtpFileSystemConfigBuilder.getConnectTimeoutDuration(FileSystemOptions)
.