Package org.apache.commons.vfs2.provider.http5

Class Http5FileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

org.apache.commons.vfs2.provider.http5.Http5FileSystemConfigBuilder

public class Http5FileSystemConfigBuilder
extends FileSystemConfigBuilder

Configuration options builder utility for http5 provider.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	KEY_FOLLOW_REDIRECT	Defines whether the HttpClient should follow redirections from the responses.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Http5FileSystemConfigBuilder(String prefix)	Constructs an Http4FileSystemConfigBuilder.

Method Summary

Modifier and Type	Method	Description
protected Class<? extends FileSystem>	getConfigClass()	Gets the target of this configuration.
int	getConnectionTimeout(FileSystemOptions opts)	Deprecated. getConnectionTimeoutDuration(FileSystemOptions).
Duration	getConnectionTimeoutDuration(FileSystemOptions opts)	Gets the connection timeout.
org.apache.hc.client5.http.cookie.Cookie[]	getCookies(FileSystemOptions opts)	Gets the cookies to add to the request.
boolean	getFollowRedirect(FileSystemOptions opts)	Gets whether to follow redirects for the connection.
static Http5FileSystemConfigBuilder	getInstance()	Gets the singleton builder.
String	getKeyStoreFile(FileSystemOptions opts)	Gets keystore file path to be used in SSL connections.
String	getKeyStoreType(FileSystemOptions opts)	Gets keystore type for SSL connections.
int	getMaxConnectionsPerHost(FileSystemOptions opts)	Gets the maximum number of connections allowed per host.
int	getMaxTotalConnections(FileSystemOptions opts)	Gets the maximum number of connections allowed.
UserAuthenticator	getProxyAuthenticator(FileSystemOptions opts)	Gets the proxy authenticator where the system should get the credentials from.
String	getProxyHost(FileSystemOptions opts)	Gets the proxy to use for http connection.
int	getProxyPort(FileSystemOptions opts)	Gets the proxy-port to use for http the connection.
String	getProxyScheme(FileSystemOptions opts)	Gets the proxy-scheme to use for http the connection.
int	getSoTimeout(FileSystemOptions opts)	Deprecated. Use getSoTimeoutDuration(FileSystemOptions).
Duration	getSoTimeoutDuration(FileSystemOptions opts)	Gets the socket timeout.
String	getTlsVersions(FileSystemOptions opts)	Gets the enabled TLS versions as a comma separated string, each token of which is the name of org.apache.hc.core5.http.ssl.TLS enum. e.g, "V_1_2, V_1_3".
String	getUrlCharset(FileSystemOptions opts)	Gets the charset used for url encoding.
String	getUserAgent(FileSystemOptions opts)	Gets the user agent string.
boolean	isHostnameVerificationEnabled(FileSystemOptions opts)	Determines if the hostname should be verified in SSL context.
boolean	isKeepAlive(FileSystemOptions opts)	Determines if the FileSystemOptions indicate that HTTP Keep-Alive is respected.
boolean	isPreemptiveAuth(FileSystemOptions opts)	Determines if the FileSystemOptions indicate that preemptive authentication is requested.
void	setConnectionTimeout(FileSystemOptions opts, int connectionTimeout)	Deprecated. Use setConnectionTimeout(FileSystemOptions, Duration).
void	setConnectionTimeout(FileSystemOptions opts, Duration connectionTimeout)	Sets the connection timeout.
void	setCookies(FileSystemOptions opts, org.apache.hc.client5.http.cookie.Cookie[] cookies)	The cookies to add to the request.
void	setFollowRedirect(FileSystemOptions opts, boolean redirect)	Sets whether to follow redirects for the connection.
void	setHostnameVerificationEnabled(FileSystemOptions opts, boolean hostnameVerificationEnabled)	Sets if the hostname should be verified in SSL context.
void	setKeepAlive(FileSystemOptions opts, boolean keepAlive)	Sets if the FileSystemOptions indicate that HTTP Keep-Alive is respected.
void	setKeyStoreFile(FileSystemOptions opts, String keyStoreFile)	Sets keystore file path for SSL connections.
void	setKeyStorePass(FileSystemOptions opts, String keyStorePass)	Sets keystore pass phrase for SSL connections.
void	setKeyStoreType(FileSystemOptions opts, String keyStoreType)	Sets keystore type for SSL connections.
void	setMaxConnectionsPerHost(FileSystemOptions opts, int maxHostConnections)	Sets the maximum number of connections allowed to any host.
void	setMaxTotalConnections(FileSystemOptions opts, int maxTotalConnections)	Sets the maximum number of connections allowed.
void	setPreemptiveAuth(FileSystemOptions opts, boolean preemptiveAuth)	Sets the given value for preemptive HTTP authentication (using BASIC) on the given FileSystemOptions object.
void	setProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator)	Sets the proxy authenticator where the system should get the credentials from.
void	setProxyHost(FileSystemOptions opts, String proxyHost)	Sets the proxy to use for http connection.
void	setProxyPort(FileSystemOptions opts, int proxyPort)	Sets the proxy-port to use for http connection.
void	setProxyScheme(FileSystemOptions opts, String proxyScheme)	Sets the proxy-scheme to use for http connection.
void	setSoTimeout(FileSystemOptions opts, int soTimeout)	Deprecated. Use setSoTimeout(FileSystemOptions, Duration).
void	setSoTimeout(FileSystemOptions opts, Duration soTimeout)	The socket timeout.
void	setTlsVersions(FileSystemOptions opts, String tlsVersions)	Sets the enabled TLS versions as a comma separated string, each token of which is the name of org.apache.hc.core5.http.ssl.TLS enum. e.g, "V_1_2, V_1_3".
void	setUrlCharset(FileSystemOptions opts, String charset)	Sets the charset used for url encoding.
void	setUserAgent(FileSystemOptions opts, String userAgent)	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_FOLLOW_REDIRECT

protected static final String KEY_FOLLOW_REDIRECT

Defines whether the HttpClient should follow redirections from the responses.

This parameter expects a value of type Boolean.

See Also:

• Constant Field Values

Constructor Details

Http5FileSystemConfigBuilder

protected Http5FileSystemConfigBuilder(String prefix)

Constructs an Http4FileSystemConfigBuilder.

Parameters:

prefix - String for properties of this file system.

Method Details

getInstance

public static Http5FileSystemConfigBuilder getInstance()

Gets the singleton builder.

Returns:

the singleton builder.

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Description copied from class: FileSystemConfigBuilder

Gets the target of this configuration.

Specified by:

getConfigClass in class FileSystemConfigBuilder

Returns:

the specific file system class

getConnectionTimeout

@Deprecated
public int getConnectionTimeout(FileSystemOptions opts)

Deprecated.

getConnectionTimeoutDuration(FileSystemOptions).

Gets the connection timeout.

Parameters:

opts - The FileSystem options.

Returns:

The connection timeout.

getConnectionTimeoutDuration

public Duration getConnectionTimeoutDuration(FileSystemOptions opts)

Gets the connection timeout.

Parameters:

opts - The FileSystem options.

Returns:

The connection timeout.

Since:

2.8.0

getCookies

public org.apache.hc.client5.http.cookie.Cookie[] getCookies(FileSystemOptions opts)

Gets the cookies to add to the request.

Parameters:

opts - The FileSystem options.

Returns:

the Cookie array.

getFollowRedirect

public boolean getFollowRedirect(FileSystemOptions opts)

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 String getKeyStoreFile(FileSystemOptions opts)

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 String getKeyStoreType(FileSystemOptions opts)

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)

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)

Gets the maximum number of connections allowed.

Parameters:

opts - The FileSystemOptions.

Returns:

The maximum number of connections allowed.

getProxyAuthenticator

public UserAuthenticator getProxyAuthenticator(FileSystemOptions opts)

Gets the proxy authenticator where the system should get the credentials from.

Parameters:

opts - The FileSystem options.

Returns:

The UserAuthenticator.

getProxyHost

public String getProxyHost(FileSystemOptions opts)

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)

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 String getProxyScheme(FileSystemOptions opts)

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.

Use getSoTimeoutDuration(FileSystemOptions).

Gets the socket timeout.

Parameters:

opts - The FileSystemOptions.

Returns:

The socket timeout.

getSoTimeoutDuration

public Duration getSoTimeoutDuration(FileSystemOptions opts)

Gets the socket timeout.

Parameters:

opts - The FileSystemOptions.

Returns:

The socket timeout.

Since:

2.8.0

getTlsVersions

public String getTlsVersions(FileSystemOptions opts)

Gets the enabled TLS versions as a comma separated string, each token of which is the name of org.apache.hc.core5.http.ssl.TLS enum. e.g, "V_1_2, V_1_3".

Parameters:

opts - the file system options to modify

Returns:

enabled TLS versions

getUrlCharset

public String getUrlCharset(FileSystemOptions opts)

Gets the charset used for url encoding.

Parameters:

opts - The FileSystem options.

Returns:

the charset name

getUserAgent

public String getUserAgent(FileSystemOptions opts)

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)

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)

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)

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,
 Duration connectionTimeout)

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.

Use setConnectionTimeout(FileSystemOptions, Duration).

Sets the connection timeout.

Parameters:

opts - The FileSystem options.

connectionTimeout - The connection timeout.

setCookies

public void setCookies(FileSystemOptions opts,
 org.apache.hc.client5.http.cookie.Cookie[] cookies)

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)

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)

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)

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,
 String keyStoreFile)

Sets keystore file path for SSL connections.

Parameters:

opts - the file system options to modify

keyStoreFile - keystore file path

setKeyStorePass

public void setKeyStorePass(FileSystemOptions opts,
 String keyStorePass)

Sets keystore pass phrase for SSL connections.

Parameters:

opts - the file system options to modify

keyStorePass - keystore pass phrase for SSL connections

setKeyStoreType

public void setKeyStoreType(FileSystemOptions opts,
 String keyStoreType)

Sets keystore type for SSL connections.

Parameters:

opts - the file system options to modify

keyStoreType - keystore type for SSL connections

Since:

2.7.0

setMaxConnectionsPerHost

public void setMaxConnectionsPerHost(FileSystemOptions opts,
 int maxHostConnections)

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)

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)

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)

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,
 String proxyHost)

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)

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,
 String proxyScheme)

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,
 Duration soTimeout)

The socket timeout.

Parameters:

opts - The FileSystem options.

soTimeout - socket timeout.

setSoTimeout

@Deprecated
public void setSoTimeout(FileSystemOptions opts,
 int soTimeout)

Deprecated.

Use setSoTimeout(FileSystemOptions, Duration).

Sets the socket timeout.

Parameters:

opts - The FileSystem options.

soTimeout - socket timeout.

setTlsVersions

public void setTlsVersions(FileSystemOptions opts,
 String tlsVersions)

Sets the enabled TLS versions as a comma separated string, each token of which is the name of org.apache.hc.core5.http.ssl.TLS enum. e.g, "V_1_2, V_1_3".

Parameters:

opts - the file system options to modify

tlsVersions - enabled TLS versions

setUrlCharset

public void setUrlCharset(FileSystemOptions opts,
 String charset)

Sets the charset used for url encoding.

Parameters:

opts - The FileSystem options.

charset - the charset name.

setUserAgent

public void setUserAgent(FileSystemOptions opts,
 String userAgent)

Sets the user agent to attach to the outgoing http methods.

Parameters:

opts - the file system options to modify

userAgent - User Agent String