Package org.apache.commons.vfs2.provider.http4

Class Http4FileSystemConfigBuilder

java.lang.Object
org.apache.commons.vfs2.FileSystemConfigBuilder
org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder
Configuration options builder utility for http4 provider.
Since:
2.3

  • Field Details

    • BUILDER

      private static final Http4FileSystemConfigBuilder BUILDER

    • MAX_TOTAL_CONNECTIONS

      private static final String MAX_TOTAL_CONNECTIONS
      Defines the maximum number of connections allowed overall. This value only applies to the number of connections from a particular instance of HTTP connection manager.

      This parameter expects a value of type Integer.

      See Also:

    • MAX_HOST_CONNECTIONS

      private static final String MAX_HOST_CONNECTIONS
      Defines the maximum number of connections allowed per host configuration. These values only apply to the number of connections from a particular instance of HTTP connection manager.
      See Also:

    • CONNECTION_TIMEOUT

      private static final String CONNECTION_TIMEOUT
      Defines the connection timeout of an HTTP request.

      This parameter expects a value of type Integer.

      See Also:

    • SO_TIMEOUT

      private static final String SO_TIMEOUT
      Defines the socket timeout of an HTTP request.

      This parameter expects a value of type Integer.

      See Also:

    • KEEP_ALIVE

      private static final String KEEP_ALIVE
      Defines whether Keep-Alive option is used or not.

      This parameter expects a value of type Boolean.

      See Also:

    • KEYSTORE_FILE

      private static final String KEYSTORE_FILE
      Defines the keystore file path for SSL connections.

      This parameter expects a value of type String.

      See Also:

    • KEYSTORE_PASS

      private static final String KEYSTORE_PASS
      Defines the keystore pass phrase for SSL connections.

      This parameter expects a value of type String.

      See Also:

    • KEYSTORE_TYPE

      private static final String KEYSTORE_TYPE
      Defines the keystore type for the underlying HttpClient.
      See Also:

    • HOSTNAME_VERIFICATION_ENABLED

      private static final String HOSTNAME_VERIFICATION_ENABLED
      Defines whether the host name should be verified or not in SSL connections.

      This parameter expects a value of type Boolean.

      See Also:

    • 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:

    • KEY_USER_AGENT

      private static final String KEY_USER_AGENT
      Defines the User-Agent request header string of the underlying HttpClient.

      This parameter expects a value of type String.

      See Also:

    • KEY_PREEMPTIVE_AUTHENTICATION

      private static final String KEY_PREEMPTIVE_AUTHENTICATION
      Defines whether the preemptive authentication should be enabled or not.

      This parameter expects a value of type Boolean.

      See Also:

    • DEFAULT_MAX_CONNECTIONS

      private static final int DEFAULT_MAX_CONNECTIONS
      The default value for MAX_TOTAL_CONNECTIONS configuration.
      See Also:

    • DEFAULT_MAX_HOST_CONNECTIONS

      private static final int DEFAULT_MAX_HOST_CONNECTIONS
      The default value for MAX_HOST_CONNECTIONS configuration.
      See Also:

    • DEFAULT_CONNECTION_TIMEOUT

      private static final Duration DEFAULT_CONNECTION_TIMEOUT
      The default value for CONNECTION_TIMEOUT configuration.

    • DEFAULT_SO_TIMEOUT

      private static final Duration DEFAULT_SO_TIMEOUT
      The default value for SO_TIMEOUT configuration.

    • DEFAULT_KEEP_ALIVE

      private static final boolean DEFAULT_KEEP_ALIVE
      The default value for KEEP_ALIVE configuration.
      See Also:

    • DEFAULT_FOLLOW_REDIRECT

      private static final boolean DEFAULT_FOLLOW_REDIRECT
      The default value for KEY_FOLLOW_REDIRECT configuration.
      See Also:

    • DEFAULT_USER_AGENT

      private static final String DEFAULT_USER_AGENT
      The default value for KEY_USER_AGENT configuration.
      See Also:

    • DEFAULT_HOSTNAME_VERIFICATION_ENABLED

      private static final boolean DEFAULT_HOSTNAME_VERIFICATION_ENABLED
      The default value for HOSTNAME_VERIFICATION_ENABLED configuration.
      See Also:

    • PROXY_SCHEME

      private static final String PROXY_SCHEME
      Defines http scheme for proxy host

      This parameter expects a value of type String.

      See Also:

  • Constructor Details

    • Http4FileSystemConfigBuilder

      private Http4FileSystemConfigBuilder()

    • Http4FileSystemConfigBuilder

      protected Http4FileSystemConfigBuilder(String prefix)
      Construct an Http4FileSystemConfigBuilder.
      Parameters:
      prefix - String for properties of this file system.

  • Method Details

    • getInstance

      public static Http4FileSystemConfigBuilder 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.
      Use 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.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:

    • getKeyStoreFile

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

    • getKeyStorePass

      String getKeyStorePass(FileSystemOptions opts)
      Return keystore pass phrase for SSL connections.
      Parameters:
      opts - the file system options to modify
      Returns:
      keystore pass phrase for SSL connections

    • getKeyStoreType

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

    • 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:

    • 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:

    • 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

    • getUrlCharset

      public String getUrlCharset(FileSystemOptions opts)
      Sets 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 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 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.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:

    • 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)
      Set 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)
      Set keystore pass phrase for SSL connecdtions.
      Parameters:
      opts - the file system options to modify
      keyStorePass - keystore pass phrase for SSL connecdtions

    • setKeyStoreType

      public void setKeyStoreType(FileSystemOptions opts, String keyStoreType)
      Set 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

      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:

    • 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:

    • setSoTimeout

      public void setSoTimeout(FileSystemOptions opts, Duration soTimeout)
      Sets 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.

    • 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