Class Http4FileSystemConfigBuilder
- java.lang.Object
-
- org.apache.commons.vfs2.FileSystemConfigBuilder
-
- org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
-
@Deprecated public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder
Deprecated.Useorg.apache.commons.vfs2.provider.http5
.Configuration options builder utility for http4 provider.- Since:
- 2.3
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
KEY_FOLLOW_REDIRECT
Deprecated.Defines whether the HttpClient should follow redirections from the responses.
-
Constructor Summary
Constructors Modifier Constructor Description protected
Http4FileSystemConfigBuilder(java.lang.String prefix)
Deprecated.Constructs anHttp4FileSystemConfigBuilder
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.lang.Class<? extends FileSystem>
getConfigClass()
Deprecated.Gets the target of this configuration.int
getConnectionTimeout(FileSystemOptions opts)
Deprecated.java.time.Duration
getConnectionTimeoutDuration(FileSystemOptions opts)
Deprecated./** Gets the connection timeout.org.apache.http.cookie.Cookie[]
getCookies(FileSystemOptions opts)
Deprecated.Gets the cookies to add to the request.boolean
getFollowRedirect(FileSystemOptions opts)
Deprecated.Gets whether to follow redirects for the connection.static Http4FileSystemConfigBuilder
getInstance()
Deprecated.Gets the singleton builder.java.lang.String
getKeyStoreFile(FileSystemOptions opts)
Deprecated.Gets keystore file path to be used in SSL connections.java.lang.String
getKeyStoreType(FileSystemOptions opts)
Deprecated.Gets keystore type for SSL connections.int
getMaxConnectionsPerHost(FileSystemOptions opts)
Deprecated.Gets the maximum number of connections allowed per host.int
getMaxTotalConnections(FileSystemOptions opts)
Deprecated.Gets the maximum number of connections allowed.UserAuthenticator
getProxyAuthenticator(FileSystemOptions opts)
Deprecated.Gets the proxy authenticator where the system should get the credentials from.java.lang.String
getProxyHost(FileSystemOptions opts)
Deprecated.Gets the proxy to use for http connection.int
getProxyPort(FileSystemOptions opts)
Deprecated.Gets the proxy-port to use for http the connection.java.lang.String
getProxyScheme(FileSystemOptions opts)
Deprecated.Gets the proxy-scheme to use for http the connection.int
getSoTimeout(FileSystemOptions opts)
Deprecated.java.time.Duration
getSoTimeoutDuration(FileSystemOptions opts)
Deprecated.Gets the socket timeout.java.lang.String
getUrlCharset(FileSystemOptions opts)
Deprecated.Sets the charset used for url encoding.java.lang.String
getUserAgent(FileSystemOptions opts)
Deprecated.Gets the user agent string.boolean
isHostnameVerificationEnabled(FileSystemOptions opts)
Deprecated.Determines if the hostname should be verified in SSL context.boolean
isKeepAlive(FileSystemOptions opts)
Deprecated.Determines if the FileSystemOptions indicate that HTTP Keep-Alive is respected.boolean
isPreemptiveAuth(FileSystemOptions opts)
Deprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.void
setConnectionTimeout(FileSystemOptions opts, int connectionTimeout)
Deprecated.void
setConnectionTimeout(FileSystemOptions opts, java.time.Duration connectionTimeout)
Deprecated.Sets the connection timeout.void
setCookies(FileSystemOptions opts, org.apache.http.cookie.Cookie[] cookies)
Deprecated.The cookies to add to the request.void
setFollowRedirect(FileSystemOptions opts, boolean redirect)
Deprecated.Sets whether to follow redirects for the connection.void
setHostnameVerificationEnabled(FileSystemOptions opts, boolean hostnameVerificationEnabled)
Deprecated.Sets if the hostname should be verified in SSL context.void
setKeepAlive(FileSystemOptions opts, boolean keepAlive)
Deprecated.Sets if the FileSystemOptions indicate that HTTP Keep-Alive is respected.void
setKeyStoreFile(FileSystemOptions opts, java.lang.String keyStoreFile)
Deprecated.Sets keystore file path for SSL connections.void
setKeyStorePass(FileSystemOptions opts, java.lang.String keyStorePass)
Deprecated.Sets keystore pass phrase for SSL connections.void
setKeyStoreType(FileSystemOptions opts, java.lang.String keyStoreType)
Deprecated.Sets keystore type for SSL connections.void
setMaxConnectionsPerHost(FileSystemOptions opts, int maxHostConnections)
Deprecated.Sets the maximum number of connections allowed to any host.void
setMaxTotalConnections(FileSystemOptions opts, int maxTotalConnections)
Deprecated.Sets the maximum number of connections allowed.void
setPreemptiveAuth(FileSystemOptions opts, boolean preemptiveAuth)
Deprecated.Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.void
setProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator)
Deprecated.Sets the proxy authenticator where the system should get the credentials from.void
setProxyHost(FileSystemOptions opts, java.lang.String proxyHost)
Deprecated.Sets the proxy to use for http connection.void
setProxyPort(FileSystemOptions opts, int proxyPort)
Deprecated.Sets the proxy-port to use for http connection.void
setProxyScheme(FileSystemOptions opts, java.lang.String proxyScheme)
Deprecated.Sets the proxy-scheme to use for http connection.void
setSoTimeout(FileSystemOptions opts, int soTimeout)
Deprecated.void
setSoTimeout(FileSystemOptions opts, java.time.Duration soTimeout)
Deprecated.Sets the socket timeout.void
setUrlCharset(FileSystemOptions opts, java.lang.String charset)
Deprecated.Sets the charset used for URL encoding.void
setUserAgent(FileSystemOptions opts, java.lang.String userAgent)
Deprecated.Sets the user agent to attach to the outgoing http methods.-
Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder
getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getDuration, getDuration, getDurationInteger, getDurationInteger, getEnum, getEnum, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getParamOrDefault, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setParam, setRootURI, toBooleanObject
-
-
-
-
Field Detail
-
KEY_FOLLOW_REDIRECT
protected static final java.lang.String KEY_FOLLOW_REDIRECT
Deprecated.Defines whether the HttpClient should follow redirections from the responses.This parameter expects a value of type
Boolean
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Http4FileSystemConfigBuilder
protected Http4FileSystemConfigBuilder(java.lang.String prefix)
Deprecated.Constructs anHttp4FileSystemConfigBuilder
.- Parameters:
prefix
- String for properties of this file system.
-
-
Method Detail
-
getInstance
public static Http4FileSystemConfigBuilder getInstance()
Deprecated.Gets the singleton builder.- Returns:
- the singleton builder.
-
getConfigClass
protected java.lang.Class<? extends FileSystem> getConfigClass()
Deprecated.Description copied from class:FileSystemConfigBuilder
Gets the target of this configuration.- Specified by:
getConfigClass
in classFileSystemConfigBuilder
- Returns:
- the specific file system class
-
getConnectionTimeout
@Deprecated public int getConnectionTimeout(FileSystemOptions opts)
Deprecated.Gets the connection timeout.- Parameters:
opts
- The FileSystem options.- Returns:
- The connection timeout.
-
getConnectionTimeoutDuration
public java.time.Duration getConnectionTimeoutDuration(FileSystemOptions opts)
Deprecated./** Gets the connection timeout.- Parameters:
opts
- The FileSystem options.- Returns:
- The connection timeout.
- Since:
- 2.8.0
-
getCookies
public org.apache.http.cookie.Cookie[] getCookies(FileSystemOptions opts)
Deprecated.Gets the cookies to add to the request.- Parameters:
opts
- The FileSystem options.- Returns:
- the Cookie array.
-
getFollowRedirect
public boolean getFollowRedirect(FileSystemOptions opts)
Deprecated.Gets whether to follow redirects for the connection.- Parameters:
opts
- The FileSystem options.- Returns:
true
to follow redirects,false
not to.- See Also:
setFollowRedirect(org.apache.commons.vfs2.FileSystemOptions, boolean)
-
getKeyStoreFile
public java.lang.String getKeyStoreFile(FileSystemOptions opts)
Deprecated.Gets keystore file path to be used in SSL connections.- Parameters:
opts
- the file system options to modify- Returns:
- keystore file path to be used in SSL connections
-
getKeyStoreType
public java.lang.String getKeyStoreType(FileSystemOptions opts)
Deprecated.Gets keystore type for SSL connections.- Parameters:
opts
- the file system options to modify- Returns:
- keystore type for SSL connections
- Since:
- 2.7.0
-
getMaxConnectionsPerHost
public int getMaxConnectionsPerHost(FileSystemOptions opts)
Deprecated.Gets the maximum number of connections allowed per host.- Parameters:
opts
- The FileSystemOptions.- Returns:
- The maximum number of connections allowed per host.
-
getMaxTotalConnections
public int getMaxTotalConnections(FileSystemOptions opts)
Deprecated.Gets the maximum number of connections allowed.- Parameters:
opts
- The FileSystemOptions.- Returns:
- The maximum number of connections allowed.
-
getProxyAuthenticator
public UserAuthenticator getProxyAuthenticator(FileSystemOptions opts)
Deprecated.Gets the proxy authenticator where the system should get the credentials from.- Parameters:
opts
- The FileSystem options.- Returns:
- The UserAuthenticator.
-
getProxyHost
public java.lang.String getProxyHost(FileSystemOptions opts)
Deprecated.Gets the proxy to use for http connection. You have to set the ProxyPort too if you would like to have the proxy really used.- Parameters:
opts
- The FileSystem options.- Returns:
- proxyHost
- See Also:
setProxyPort(org.apache.commons.vfs2.FileSystemOptions, int)
-
getProxyPort
public int getProxyPort(FileSystemOptions opts)
Deprecated.Gets the proxy-port to use for http the connection. You have to set the ProxyHost too if you would like to have the proxy really used.- Parameters:
opts
- The FileSystem options.- Returns:
- proxyPort: the port number or 0 if it is not set
- See Also:
setProxyHost(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
-
getProxyScheme
public java.lang.String getProxyScheme(FileSystemOptions opts)
Deprecated.Gets the proxy-scheme to use for http the connection. You have to set the ProxyHost too if you would like to have the proxy really used.- Parameters:
opts
- The FileSystem options.- Returns:
- proxyScheme: the http/https scheme of proxy server
- Since:
- 2.7.0
- See Also:
setProxyHost(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
-
getSoTimeout
@Deprecated public int getSoTimeout(FileSystemOptions opts)
Deprecated.Gets the socket timeout.- Parameters:
opts
- The FileSystemOptions.- Returns:
- The socket timeout.
-
getSoTimeoutDuration
public java.time.Duration getSoTimeoutDuration(FileSystemOptions opts)
Deprecated.Gets the socket timeout.- Parameters:
opts
- The FileSystemOptions.- Returns:
- The socket timeout.
- Since:
- 2.8.0
-
getUrlCharset
public java.lang.String getUrlCharset(FileSystemOptions opts)
Deprecated.Sets the charset used for url encoding.- Parameters:
opts
- The FileSystem options.- Returns:
- the charset name.
-
getUserAgent
public java.lang.String getUserAgent(FileSystemOptions opts)
Deprecated.Gets the user agent string.- Parameters:
opts
- the file system options to modify- Returns:
- User provided User-Agent string, otherwise default of: Commons-VFS
-
isHostnameVerificationEnabled
public boolean isHostnameVerificationEnabled(FileSystemOptions opts)
Deprecated.Determines if the hostname should be verified in SSL context.- Parameters:
opts
- The FileSystemOptions.- Returns:
- true if the FileSystemOptions indicate that HTTP Keep-Alive is respected.
-
isKeepAlive
public boolean isKeepAlive(FileSystemOptions opts)
Deprecated.Determines if the FileSystemOptions indicate that HTTP Keep-Alive is respected.- Parameters:
opts
- The FileSystemOptions.- Returns:
- true if the FileSystemOptions indicate that HTTP Keep-Alive is respected.
-
isPreemptiveAuth
public boolean isPreemptiveAuth(FileSystemOptions opts)
Deprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.- Parameters:
opts
- The FileSystemOptions.- Returns:
- true if preemptiveAuth is requested.
-
setConnectionTimeout
public void setConnectionTimeout(FileSystemOptions opts, java.time.Duration connectionTimeout)
Deprecated.Sets the connection timeout.- Parameters:
opts
- The FileSystem options.connectionTimeout
- The connection timeout.- Since:
- 2.8.0
-
setConnectionTimeout
@Deprecated public void setConnectionTimeout(FileSystemOptions opts, int connectionTimeout)
Deprecated.Sets the connection timeout.- Parameters:
opts
- The FileSystem options.connectionTimeout
- The connection timeout.
-
setCookies
public void setCookies(FileSystemOptions opts, org.apache.http.cookie.Cookie[] cookies)
Deprecated.The cookies to add to the request.- Parameters:
opts
- The FileSystem options.cookies
- An array of Cookies.
-
setFollowRedirect
public void setFollowRedirect(FileSystemOptions opts, boolean redirect)
Deprecated.Sets whether to follow redirects for the connection.- Parameters:
opts
- The FileSystem options.redirect
-true
to follow redirects,false
not to.- See Also:
setFollowRedirect(org.apache.commons.vfs2.FileSystemOptions, boolean)
-
setHostnameVerificationEnabled
public void setHostnameVerificationEnabled(FileSystemOptions opts, boolean hostnameVerificationEnabled)
Deprecated.Sets if the hostname should be verified in SSL context.- Parameters:
opts
- The FileSystemOptions.hostnameVerificationEnabled
- whether hostname should be verified
-
setKeepAlive
public void setKeepAlive(FileSystemOptions opts, boolean keepAlive)
Deprecated.Sets if the FileSystemOptions indicate that HTTP Keep-Alive is respected.- Parameters:
opts
- The FileSystemOptions.keepAlive
- whether the FileSystemOptions indicate that HTTP Keep-Alive is respected or not.
-
setKeyStoreFile
public void setKeyStoreFile(FileSystemOptions opts, java.lang.String keyStoreFile)
Deprecated.Sets keystore file path for SSL connections.- Parameters:
opts
- the file system options to modifykeyStoreFile
- keystore file path
-
setKeyStorePass
public void setKeyStorePass(FileSystemOptions opts, java.lang.String keyStorePass)
Deprecated.Sets keystore pass phrase for SSL connections.- Parameters:
opts
- the file system options to modifykeyStorePass
- keystore pass phrase for SSL connections
-
setKeyStoreType
public void setKeyStoreType(FileSystemOptions opts, java.lang.String keyStoreType)
Deprecated.Sets keystore type for SSL connections.- Parameters:
opts
- the file system options to modifykeyStoreType
- keystore type for SSL connections- Since:
- 2.7.0
-
setMaxConnectionsPerHost
public void setMaxConnectionsPerHost(FileSystemOptions opts, int maxHostConnections)
Deprecated.Sets the maximum number of connections allowed to any host.- Parameters:
opts
- The FileSystem options.maxHostConnections
- The maximum number of connections to a host.
-
setMaxTotalConnections
public void setMaxTotalConnections(FileSystemOptions opts, int maxTotalConnections)
Deprecated.Sets the maximum number of connections allowed.- Parameters:
opts
- The FileSystem options.maxTotalConnections
- The maximum number of connections.
-
setPreemptiveAuth
public void setPreemptiveAuth(FileSystemOptions opts, boolean preemptiveAuth)
Deprecated.Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object. Defaults to false if not set. It may be appropriate to set to true in cases when the resulting chattiness of the conversation outweighs any architectural desire to use a stronger authentication scheme than basic/preemptive.- Parameters:
opts
- The FileSystemOptions.preemptiveAuth
- the desired setting; true=enabled and false=disabled.
-
setProxyAuthenticator
public void setProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator)
Deprecated.Sets the proxy authenticator where the system should get the credentials from.- Parameters:
opts
- The FileSystem options.authenticator
- The UserAuthenticator.
-
setProxyHost
public void setProxyHost(FileSystemOptions opts, java.lang.String proxyHost)
Deprecated.Sets the proxy to use for http connection.You have to set the ProxyPort too if you would like to have the proxy really used.
- Parameters:
opts
- The FileSystem options.proxyHost
- the host- See Also:
setProxyPort(org.apache.commons.vfs2.FileSystemOptions, int)
-
setProxyPort
public void setProxyPort(FileSystemOptions opts, int proxyPort)
Deprecated.Sets the proxy-port to use for http connection. You have to set the ProxyHost too if you would like to have the proxy really used.- Parameters:
opts
- The FileSystem options.proxyPort
- the port- See Also:
setProxyHost(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
-
setProxyScheme
public void setProxyScheme(FileSystemOptions opts, java.lang.String proxyScheme)
Deprecated.Sets the proxy-scheme to use for http connection. You have to set the ProxyHost too if you would like to have the proxy really used.- Parameters:
opts
- The FileSystem options.proxyScheme
- the protocol scheme- Since:
- 2.7.0
- See Also:
setProxyHost(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
-
setSoTimeout
public void setSoTimeout(FileSystemOptions opts, java.time.Duration soTimeout)
Deprecated.Sets the socket timeout.- Parameters:
opts
- The FileSystem options.soTimeout
- socket timeout.
-
setSoTimeout
@Deprecated public void setSoTimeout(FileSystemOptions opts, int soTimeout)
Deprecated.Sets the socket timeout.- Parameters:
opts
- The FileSystem options.soTimeout
- socket timeout.
-
setUrlCharset
public void setUrlCharset(FileSystemOptions opts, java.lang.String charset)
Deprecated.Sets the charset used for URL encoding.- Parameters:
opts
- The FileSystem options.charset
- the charset name.
-
setUserAgent
public void setUserAgent(FileSystemOptions opts, java.lang.String userAgent)
Deprecated.Sets the user agent to attach to the outgoing http methods.- Parameters:
opts
- the file system options to modifyuserAgent
- User Agent String
-
-