Class HttpFileSystemConfigBuilder
java.lang.Object
org.apache.commons.vfs2.FileSystemConfigBuilder
org.apache.commons.vfs2.provider.http.HttpFileSystemConfigBuilder
Deprecated.
Configuration options for HTTP.
- 
Field SummaryFields
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedHttpFileSystemConfigBuilder(String prefix) Deprecated.Creates new config builder.
- 
Method SummaryModifier and TypeMethodDescriptionprotected Class<? extends FileSystem> Deprecated.Gets the target of this configuration.intDeprecated.Deprecated.Gets the connection timeout.org.apache.commons.httpclient.Cookie[]getCookies(FileSystemOptions opts) Deprecated.Gets the cookies to add to the request.booleanDeprecated.Gets whether to follow redirects for the connection.static HttpFileSystemConfigBuilderDeprecated.Gets the singleton builder.intDeprecated.Gets the maximum number of connections allowed per host.intDeprecated.Gets the maximum number of connections allowed.Deprecated.Gets the proxy authenticator where the system should get the credentials from.Deprecated.Gets the proxy to use for http connection.intDeprecated.Gets the proxy-port to use for http the connection.intDeprecated.Deprecated.Gets the socket timeout.Deprecated.Gets the charset used for url encoding.Deprecated.Gets the user agent string.booleanDeprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.voidsetConnectionTimeout(FileSystemOptions opts, int timeout) Deprecated.voidsetConnectionTimeout(FileSystemOptions opts, Duration timeout) Deprecated.The connection timeout.voidsetCookies(FileSystemOptions opts, org.apache.commons.httpclient.Cookie[] cookies) Deprecated.The cookies to add to the request.voidsetFollowRedirect(FileSystemOptions opts, boolean redirect) Deprecated.Sets whether to follow redirects for the connection.voidsetMaxConnectionsPerHost(FileSystemOptions opts, int maxHostConnections) Deprecated.Sets the maximum number of connections allowed to any host.voidsetMaxTotalConnections(FileSystemOptions opts, int maxTotalConnections) Deprecated.Sets the maximum number of connections allowed.voidsetPreemptiveAuth(FileSystemOptions opts, boolean preemptiveAuth) Deprecated.Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.voidsetProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator) Deprecated.Sets the proxy authenticator where the system should get the credentials from.voidsetProxyHost(FileSystemOptions opts, String proxyHost) Deprecated.Sets the proxy to use for http connection.voidsetProxyPort(FileSystemOptions opts, int proxyPort) Deprecated.Sets the proxy-port to use for http connection.voidsetSoTimeout(FileSystemOptions opts, int timeout) Deprecated.voidsetSoTimeout(FileSystemOptions opts, Duration timeout) Deprecated.The socket timeout.voidsetUrlCharset(FileSystemOptions opts, String charset) Deprecated.Sets the charset used for url encoding.voidsetUserAgent(FileSystemOptions opts, String userAgent) Deprecated.Sets the user agent to attach to the outgoing http methods.Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuildergetBoolean, 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 Details- 
KEY_FOLLOW_REDIRECTDeprecated.Keys for FileSystemOptions.- See Also:
 
- 
KEY_USER_AGENTDeprecated.Keys for FileSystemOptions.- See Also:
 
 
- 
- 
Constructor Details- 
HttpFileSystemConfigBuilderDeprecated.Creates new config builder.- Parameters:
- prefix- String for properties of this file system.
- Since:
- 2.0
 
 
- 
- 
Method Details- 
getInstanceDeprecated.Gets the singleton builder.- Returns:
- the singleton builder.
 
- 
getConfigClassDeprecated.Description copied from class:FileSystemConfigBuilderGets the target of this configuration.- Specified by:
- getConfigClassin class- FileSystemConfigBuilder
- Returns:
- the specific file system class
 
- 
getConnectionTimeoutDeprecated.Gets the connection timeout.- Parameters:
- opts- The FileSystem options.
- Returns:
- The connection timeout.
- Since:
- 2.1
 
- 
getConnectionTimeoutDurationDeprecated.Gets the connection timeout.- Parameters:
- opts- The FileSystem options.
- Returns:
- The connection timeout.
- Since:
- 2.8.0
 
- 
getCookiesDeprecated.Gets the cookies to add to the request.- Parameters:
- opts- The FileSystem options.
- Returns:
- the Cookie array.
 
- 
getFollowRedirectDeprecated.Gets whether to follow redirects for the connection.- Parameters:
- opts- The FileSystem options.
- Returns:
- trueto follow redirects,- falsenot to.
- Since:
- 2.1
- See Also:
 
- 
getMaxConnectionsPerHostDeprecated.Gets the maximum number of connections allowed per host.- Parameters:
- opts- The FileSystemOptions.
- Returns:
- The maximum number of connections allowed per host.
- Since:
- 2.0
 
- 
getMaxTotalConnectionsDeprecated.Gets the maximum number of connections allowed.- Parameters:
- opts- The FileSystemOptions.
- Returns:
- The maximum number of connections allowed.
- Since:
- 2.0
 
- 
getProxyAuthenticatorDeprecated.Gets the proxy authenticator where the system should get the credentials from.- Parameters:
- opts- The FileSystem options.
- Returns:
- The UserAuthenticator.
 
- 
getProxyHostDeprecated.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:
 
- 
getProxyPortDeprecated.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:
 
- 
getSoTimeoutDeprecated.Gets the socket timeout.- Parameters:
- opts- The FileSystemOptions.
- Returns:
- The socket timeout.
- Since:
- 2.1
 
- 
getSoTimeoutDurationDeprecated.Gets the socket timeout.- Parameters:
- opts- The FileSystemOptions.
- Returns:
- The socket timeout.
- Since:
- 2.8.0
 
- 
getUrlCharsetDeprecated.Gets the charset used for url encoding.- Parameters:
- opts- The FileSystem options.
- Returns:
- the charset name.
 
- 
getUserAgentDeprecated.Gets the user agent string.- Parameters:
- opts- the file system options to modify
- Returns:
- User provided User-Agent string, otherwise default of: Commons-VFS
 
- 
isPreemptiveAuthDeprecated.Determines if the FileSystemOptions indicate that preemptive authentication is requested.- Parameters:
- opts- The FileSystemOptions.
- Returns:
- true if preemptiveAuth is requested.
- Since:
- 2.0
 
- 
setConnectionTimeoutDeprecated.The connection timeout.- Parameters:
- opts- The FileSystem options.
- timeout- The connection timeout.
- Since:
- 2.8.0
 
- 
setConnectionTimeoutDeprecated.The connection timeout.- Parameters:
- opts- The FileSystem options.
- timeout- The connection timeout.
- Since:
- 2.1
 
- 
setCookiesDeprecated.The cookies to add to the request.- Parameters:
- opts- The FileSystem options.
- cookies- An array of Cookies.
 
- 
setFollowRedirectDeprecated.Sets whether to follow redirects for the connection.- Parameters:
- opts- The FileSystem options.
- redirect-- trueto follow redirects,- falsenot to.
- Since:
- 2.1
- See Also:
 
- 
setMaxConnectionsPerHostDeprecated.Sets the maximum number of connections allowed to any host.- Parameters:
- opts- The FileSystem options.
- maxHostConnections- The maximum number of connections to a host.
- Since:
- 2.0
 
- 
setMaxTotalConnectionsDeprecated.Sets the maximum number of connections allowed.- Parameters:
- opts- The FileSystem options.
- maxTotalConnections- The maximum number of connections.
- Since:
- 2.0
 
- 
setPreemptiveAuthDeprecated.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.
 
- 
setProxyAuthenticatorDeprecated.Sets the proxy authenticator where the system should get the credentials from.- Parameters:
- opts- The FileSystem options.
- authenticator- The UserAuthenticator.
 
- 
setProxyHostDeprecated.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:
 
- 
setProxyPortDeprecated.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:
 
- 
setSoTimeoutDeprecated.The socket timeout.- Parameters:
- opts- The FileSystem options.
- timeout- socket timeout.
- Since:
- 2.8.0
 
- 
setSoTimeoutDeprecated.The socket timeout.- Parameters:
- opts- The FileSystem options.
- timeout- socket timeout.
- Since:
- 2.1
 
- 
setUrlCharsetDeprecated.Sets the charset used for url encoding.- Parameters:
- opts- The FileSystem options.
- charset- the charset name.
 
- 
setUserAgentDeprecated.Sets the user agent to attach to the outgoing http methods.- Parameters:
- opts- the file system options to modify
- userAgent- User Agent String
 
 
- 
org.apache.commons.vfs2.provider.http5.