GenericHttpClientFactory (Norconex HTTP Collector 2.9.1 API)

java.lang.Object
- com.norconex.collector.http.client.impl.GenericHttpClientFactory

All Implemented Interfaces:: IHttpClientFactory, IXMLConfigurable

public class GenericHttpClientFactory
extends Object
implements IHttpClientFactory, IXMLConfigurable

Default implementation of IHttpClientFactory.

Password encryption in XML configuration:

As of 2.4.0, proxyPassword and authPassword can take a password that has been encrypted using EncryptionUtil. In order for the password to be decrypted properly by the crawler, you need to specify the encryption key used to encrypt it. The key can be stored in a few supported locations and a combination of [auth|proxy]PasswordKey and [auth|proxy]PasswordKeySource must be specified to properly locate the key. The supported sources are:

`[...]PasswordKeySource`	`[...]PasswordKey`
`key`	The actual encryption key.
`file`	Path to a file containing the encryption key.
`environment`	Name of an environment variable containing the key.
`property`	Name of a JVM system property containing the key.

As of 2.7.0, XML configuration entries expecting millisecond durations can be provided in human-readable format (English only), as per DurationParser (e.g., "5 minutes and 30 seconds" or "5m30s").

XML configuration usage:

  <httpClientFactory class="com.norconex.collector.http.client.impl.GenericHttpClientFactory">
      <cookiesDisabled>[false|true]</cookiesDisabled>
      <connectionTimeout>(milliseconds)</connectionTimeout>
      <socketTimeout>(milliseconds)</socketTimeout>
      <connectionRequestTimeout>(milliseconds)</connectionRequestTimeout>
      <connectionCharset>...</connectionCharset>
      <expectContinueEnabled>[false|true]</expectContinueEnabled>
      <maxRedirects>...</maxRedirects>
      <localAddress>...</localAddress>
      <maxConnections>...</maxConnections>
      <maxConnectionsPerRoute>...</maxConnectionsPerRoute>
      <maxConnectionIdleTime>(milliseconds)</maxConnectionIdleTime>
      <maxConnectionInactiveTime>(milliseconds)</maxConnectionInactiveTime>

      <!-- Be warned: trusting all certificates is usually a bad idea. -->
      <trustAllSSLCertificates>[false|true]</trustAllSSLCertificates>

      <!-- Since 2.6.2, you can specify SSL/TLS protocols to use -->
      <sslProtocols>(coma-separated list)</sslProtocols>

      <proxyHost>...</proxyHost>
      <proxyPort>...</proxyPort>
      <proxyRealm>...</proxyRealm>
      <proxyScheme>...</proxyScheme>
      <proxyUsername>...</proxyUsername>
      <proxyPassword>...</proxyPassword>
      <!-- Use the following if password is encrypted. -->
      <proxyPasswordKey>(the encryption key or a reference to it)</proxyPasswordKey>
      <proxyPasswordKeySource>[key|file|environment|property]</proxyPasswordKeySource>

      <!-- HTTP request headers passed on every HTTP requests -->
      <headers>
          <header name="(header name)">(header value)</header>
          <!-- You can repeat this header tag as needed. -->
      </headers>

      <authMethod>[form|basic|digest|ntlm|spnego|kerberos]</authMethod>

      <!-- These apply to any authentication mechanism -->
      <authUsername>...</authUsername>
      <authPassword>...</authPassword>
      <!-- Use the following if password is encrypted. -->
      <authPasswordKey>(the encryption key or a reference to it)</authPasswordKey>
      <authPasswordKeySource>[key|file|environment|property]</authPasswordKeySource>

      <!-- These apply to FORM authentication -->
      <authUsernameField>...</authUsernameField>
      <authPasswordField>...</authPasswordField>
      <authURL>...</authURL>
      <authFormCharset>...</authFormCharset>
      <!-- Extra form parameters required to authenticate (since 2.8.0) -->
      <authFormParams>
          <param name="(param name)">(param value)</param>
          <!-- You can repeat this param tag as needed. -->
      </authFormParams>

      <!-- These apply to both BASIC and DIGEST authentication -->
      <authHostname>...</authHostname>
      <authPort>...</authPort>
      <authRealm>...</authRealm>

      <!-- This applies to BASIC authentication -->
      <authPreemptive>[false|true]</authPreemptive>

      <!-- These apply to NTLM authentication -->
      <authHostname>...</authHostname>
      <authPort>...</authPort>
      <authWorkstation>...</authWorkstation>
      <authDomain>...</authDomain>

  </httpClientFactory>

Usage example:

The following will authenticate the crawler to a web site before crawling. The website uses an HTML form with a username and password fields called "loginUser" and "loginPwd".

  <httpClientFactory class="com.norconex.collector.http.client.impl.GenericHttpClientFactory">
      <authUsername>joeUser</authUsername>
      <authPassword>joePasword</authPassword>
      <authUsernameField>loginUser</authUsernameField>
      <authPasswordField>loginPwd</authPasswordField>
      <authURL>http://www.example.com/login</authURL>
  </httpClientFactory>

Since:: 1.3.0
Author:: Pascal Essiembre

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_METHOD_BASIC` BASIC authentication method.
`static String`	`AUTH_METHOD_DIGEST` DIGEST authentication method.
`static String`	`AUTH_METHOD_FORM` Form-based authentication method.
`static String`	`AUTH_METHOD_KERBEROS` Experimental: Kerberos authentication method.
`static String`	`AUTH_METHOD_NTLM` NTLM authentication method.
`static String`	`AUTH_METHOD_SPNEGO` Experimental: SPNEGO authentication method.
`static int`	`DEFAULT_MAX_CONNECTIONS`
`static int`	`DEFAULT_MAX_CONNECTIONS_PER_ROUTE`
`static int`	`DEFAULT_MAX_IDLE_TIME`
`static int`	`DEFAULT_MAX_REDIRECT`
`static int`	`DEFAULT_TIMEOUT`

Constructor Summary

Constructors
Constructor and Description

GenericHttpClientFactory()

Constructors
Constructor and Description
`GenericHttpClientFactory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`authenticateUsingForm(org.apache.http.client.HttpClient httpClient)`
`protected void`	`buildCustomHttpClient(org.apache.http.impl.client.HttpClientBuilder builder)` For implementors to subclass.
`protected org.apache.http.config.ConnectionConfig`	`createConnectionConfig()`
`protected org.apache.http.client.CredentialsProvider`	`createCredentialsProvider()`
`protected org.apache.http.client.CookieStore`	`createDefaultCookieStore()` Creates the default cookie store to be added to each request context.
`protected List<org.apache.http.Header>`	`createDefaultRequestHeaders()` Creates a list of HTTP headers previously set by `setRequestHeader(String, String)`.
`org.apache.http.client.HttpClient`	`createHTTPClient(String userAgent)` Initializes the HTTP Client used for crawling.
`protected org.apache.http.HttpHost`	`createProxy()`
`protected org.apache.http.client.RedirectStrategy`	`createRedirectStrategy()`
`protected org.apache.http.client.config.RequestConfig`	`createRequestConfig()`
`protected org.apache.http.conn.SchemePortResolver`	`createSchemePortResolver()`
`protected SSLContext`	`createSSLContext()`
`protected org.apache.http.conn.socket.LayeredConnectionSocketFactory`	`createSSLSocketFactory(SSLContext sslContext)`
`boolean`	`equals(Object obj)`
`String`	`getAuthDomain()` Gets the NTLM authentication domain.
`String`	`getAuthFormCharset()` Gets the authentication form character set.
`String`	`getAuthFormParam(String name)` Gets an authentication form parameter (equivalent to "input" or other fields in HTML forms).
`String[]`	`getAuthFormParamNames()` Gets all authentication form parameter names.
`String`	`getAuthHostname()` Gets the host name for the current authentication scope.
`String`	`getAuthMethod()` Gets the authentication method.
`String`	`getAuthPassword()` Gets the authentication password.
`String`	`getAuthPasswordField()` Gets the name of the HTML field where the password is set.
`EncryptionKey`	`getAuthPasswordKey()` Gets the authentication password encryption key.
`int`	`getAuthPort()` Gets the port for the current authentication scope.
`String`	`getAuthRealm()` Gets the realm name for the current authentication scope.
`String`	`getAuthURL()` Gets the URL for "form" authentication.
`String`	`getAuthUsername()` Gets the username.
`String`	`getAuthUsernameField()` Gets the name of the HTML field where the username is set.
`String`	`getAuthWorkstation()` Gets the NTLM authentication workstation name.
`String`	`getConnectionCharset()` Gets the connection character set.
`int`	`getConnectionRequestTimeout()` Gets the timeout when requesting a connection, in milliseconds
`int`	`getConnectionTimeout()` Gets the connection timeout until a connection is established, in milliseconds.
`String`	`getCookieSpec()`
`String`	`getLocalAddress()` Gets the local address (IP or hostname).
`int`	`getMaxConnectionIdleTime()` Gets the period of time in milliseconds after which to evict idle connections from the connection pool.
`int`	`getMaxConnectionInactiveTime()` Gets the period of time in milliseconds a connection must be inactive to be checked in case it became stalled.
`int`	`getMaxConnections()` Gets the maximum number of connections that can be created.
`int`	`getMaxConnectionsPerRoute()` Gets the maximum number of connections that can be used per route.
`int`	`getMaxRedirects()` Gets the maximum number of redirects to be followed.
`String`	`getProxyHost()` Gets the proxy host.
`String`	`getProxyPassword()` Gets the proxy password.
`EncryptionKey`	`getProxyPasswordKey()` Gets the proxy password encryption key.
`int`	`getProxyPort()` Gets the proxy port.
`String`	`getProxyRealm()` Gets the proxy realm.
`String`	`getProxyScheme()` Gets the proxy scheme.
`String`	`getProxyUsername()` Gets the proxy username.
`String`	`getRequestHeader(String name)` Gets the HTTP request header value matching the given name, previously set with `setRequestHeader(String, String)`.
`String[]`	`getRequestHeaderNames()` Gets all HTTP request header names for headers previously set with `setRequestHeader(String, String)`.
`String[]`	`getRequestHeaders()` Deprecated. Since 2.8.0 use `getRequestHeaderNames()`
`int`	`getSocketTimeout()` Gets the maximum period of inactivity between two consecutive data packets, in milliseconds.
`String[]`	`getSSLProtocols()` Gets the supported SSL/TLS protocols.
`int`	`hashCode()`
`boolean`	`isAuthPreemptive()` Gets whether to perform preemptive authentication (valid for "basic" authentication method).
`boolean`	`isCookiesDisabled()` Whether cookie support is disabled.
`boolean`	`isExpectContinueEnabled()` Whether 'Expect: 100-continue' handshake is enabled.
`boolean`	`isStaleConnectionCheckDisabled()` Deprecated. Since 2.1.0. As of 2.2.0, use `getMaxConnectionInactiveTime()` instead.
`boolean`	`isTrustAllSSLCertificates()` Whether to trust all SSL certificates (affects only "https" connections).
`void`	`loadFromXML(Reader in)`
`String`	`removeAuthFormParameter(String name)` Remove the authentication form parameter matching the given name.
`String`	`removeRequestHeader(String name)` Remove the request header matching the given name.
`void`	`saveToXML(Writer out)`
`void`	`setAuthDomain(String authDomain)` Sets the NTLM authentication domain
`void`	`setAuthFormCharset(String authFormCharset)` Sets the authentication form character set for the form field values.
`void`	`setAuthFormParam(String name, String value)` Sets an authentication form parameter (equivalent to "input" or other fields in HTML forms).
`void`	`setAuthHostname(String authHostname)` Sets the host name for the current authentication scope.
`void`	`setAuthMethod(String authMethod)` Sets the authentication method.
`void`	`setAuthPassword(String authPassword)` Sets the authentication password.
`void`	`setAuthPasswordField(String authPasswordField)` Sets the name of the HTML field where the password is set.
`void`	`setAuthPasswordKey(EncryptionKey authPasswordKey)` Sets the authentication password encryption key.
`void`	`setAuthPort(int authPort)` Sets the port for the current authentication scope.
`void`	`setAuthPreemptive(boolean authPreemptive)` Sets whether to perform preemptive authentication (valid for "basic" authentication method).
`void`	`setAuthRealm(String authRealm)` Sets the realm name for the current authentication scope.
`void`	`setAuthURL(String authURL)` Sets the URL for "form" authentication.
`void`	`setAuthUsername(String authUsername)` Sets the username.
`void`	`setAuthUsernameField(String authUsernameField)` Sets the name of the HTML field where the username is set.
`void`	`setAuthWorkstation(String authWorkstation)` Sets the NTLM authentication workstation name.
`void`	`setConnectionCharset(String connectionCharset)` Sets the connection character set.
`void`	`setConnectionRequestTimeout(int connectionRequestTimeout)` Sets the timeout when requesting a connection, in milliseconds.
`void`	`setConnectionTimeout(int connectionTimeout)` Sets the connection timeout until a connection is established, in milliseconds.
`void`	`setCookiesDisabled(boolean cookiesDisabled)` Sets whether cookie support is disabled.
`void`	`setCookieSpec(String cookieSpec)`
`void`	`setExpectContinueEnabled(boolean expectContinueEnabled)` Sets whether 'Expect: 100-continue' handshake is enabled.
`void`	`setLocalAddress(String localAddress)` Sets the local address, which may be useful when working with multiple network interfaces.
`void`	`setMaxConnectionIdleTime(int maxConnectionIdleTime)` Sets the period of time in milliseconds after which to evict idle connections from the connection pool.
`void`	`setMaxConnectionInactiveTime(int maxConnectionInactiveTime)` Sets the period of time in milliseconds a connection must be inactive to be checked in case it became stalled.
`void`	`setMaxConnections(int maxConnections)` Sets maximum number of connections that can be created.
`void`	`setMaxConnectionsPerRoute(int maxConnectionsPerRoute)` Sets the maximum number of connections that can be used per route.
`void`	`setMaxRedirects(int maxRedirects)` Sets the maximum number of redirects to be followed.
`void`	`setProxyHost(String proxyHost)` Sets the proxy host.
`void`	`setProxyPassword(String proxyPassword)` Sets the proxy password.
`void`	`setProxyPasswordKey(EncryptionKey proxyPasswordKey)` Sets the proxy password encryption key.
`void`	`setProxyPort(int proxyPort)` Sets the proxy port.
`void`	`setProxyRealm(String proxyRealm)` Sets the proxy realm
`void`	`setProxyScheme(String proxyScheme)` Sets the proxy scheme.
`void`	`setProxyUsername(String proxyUsername)` Sets the proxy username
`void`	`setRequestHeader(String name, String value)` Sets a default HTTP request header every HTTP connection should have.
`void`	`setSocketTimeout(int socketTimeout)` Sets the maximum period of inactivity between two consecutive data packets, in milliseconds.
`void`	`setSSLProtocols(String... sslProtocols)` Sets the supported SSL/TLS protocols, such as SSLv3, TLSv1, TLSv1.1, and TLSv1.2.
`void`	`setStaleConnectionCheckDisabled(boolean staleConnectionCheckDisabled)` Deprecated. Since 2.1.0. As of 2.2.0, use `setMaxConnectionInactiveTime(int)` instead.
`void`	`setTrustAllSSLCertificates(boolean trustAllSSLCertificates)` Sets whether to trust all SSL certificate.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTH_METHOD_FORM
```
public static final String AUTH_METHOD_FORM
```
    Form-based authentication method.
    
    See Also:
    
    Constant Field Values
  - AUTH_METHOD_BASIC
```
public static final String AUTH_METHOD_BASIC
```
    BASIC authentication method.
    
    See Also:
    
    Constant Field Values
  - AUTH_METHOD_DIGEST
```
public static final String AUTH_METHOD_DIGEST
```
    DIGEST authentication method.
    
    See Also:
    
    Constant Field Values
  - AUTH_METHOD_NTLM
```
public static final String AUTH_METHOD_NTLM
```
    NTLM authentication method.
    
    See Also:
    
    Constant Field Values
  - AUTH_METHOD_SPNEGO
```
public static final String AUTH_METHOD_SPNEGO
```
    Experimental: SPNEGO authentication method.
    
    See Also:
    
    Constant Field Values
  - AUTH_METHOD_KERBEROS
```
public static final String AUTH_METHOD_KERBEROS
```
    Experimental: Kerberos authentication method.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final int DEFAULT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_REDIRECT
```
public static final int DEFAULT_MAX_REDIRECT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONNECTIONS
```
public static final int DEFAULT_MAX_CONNECTIONS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONNECTIONS_PER_ROUTE
```
public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IDLE_TIME
```
public static final int DEFAULT_MAX_IDLE_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GenericHttpClientFactory
```
public GenericHttpClientFactory()
```
- Method Detail
  - createHTTPClient
```
public org.apache.http.client.HttpClient createHTTPClient(String userAgent)
```
    Description copied from interface: IHttpClientFactory
    
    Initializes the HTTP Client used for crawling.
    
    Specified by:
    
    createHTTPClient in interface IHttpClientFactory
    
    Parameters:
    
    userAgent - the HTTP request "User-Agent" header value
    
    Returns:
    
    Apache HTTP Client
  - buildCustomHttpClient
```
protected void buildCustomHttpClient(org.apache.http.impl.client.HttpClientBuilder builder)
```
    For implementors to subclass. Does nothing by default.
    
    Parameters:
    
    builder - http client builder
  - authenticateUsingForm
```
protected void authenticateUsingForm(org.apache.http.client.HttpClient httpClient)
```
  - createDefaultCookieStore
```
protected org.apache.http.client.CookieStore createDefaultCookieStore()
```
    Creates the default cookie store to be added to each request context.
    
    Returns:
    
    a cookie store
    
    Since:
    
    2.4.0
  - createDefaultRequestHeaders
```
protected List<org.apache.http.Header> createDefaultRequestHeaders()
```
    Creates a list of HTTP headers previously set by setRequestHeader(String, String).
    
    Since 2.8.0, this method will also add a "Basic" authentication header if setAuthPreemptive(boolean) is true and credentials were supplied.
    
    Returns:
    
    a list of HTTP request headers
    
    Since:
    
    2.3.0
  - createRedirectStrategy
```
protected org.apache.http.client.RedirectStrategy createRedirectStrategy()
```
  - createSchemePortResolver
```
protected org.apache.http.conn.SchemePortResolver createSchemePortResolver()
```
  - createRequestConfig
```
protected org.apache.http.client.config.RequestConfig createRequestConfig()
```
  - createProxy
```
protected org.apache.http.HttpHost createProxy()
```
  - createCredentialsProvider
```
protected org.apache.http.client.CredentialsProvider createCredentialsProvider()
```
  - createConnectionConfig
```
protected org.apache.http.config.ConnectionConfig createConnectionConfig()
```
  - createSSLSocketFactory
```
protected org.apache.http.conn.socket.LayeredConnectionSocketFactory createSSLSocketFactory(SSLContext sslContext)
```
  - createSSLContext
```
protected SSLContext createSSLContext()
```
  - loadFromXML
```
public void loadFromXML(Reader in)
```
    Specified by:
    
    loadFromXML in interface IXMLConfigurable
  - saveToXML
```
public void saveToXML(Writer out)
               throws IOException
```
    Specified by:
    
    saveToXML in interface IXMLConfigurable
    
    Throws:
    
    IOException
  - setRequestHeader
```
public void setRequestHeader(String name,
                             String value)
```
    Sets a default HTTP request header every HTTP connection should have. Those are in addition to any default request headers Apache HttpClient may already provide.
    
    Parameters:
    
    name - HTTP request header name
    
    value - HTTP request header value
    
    Since:
    
    2.3.0
  - getRequestHeader
```
public String getRequestHeader(String name)
```
    Gets the HTTP request header value matching the given name, previously set with setRequestHeader(String, String).
    
    Parameters:
    
    name - HTTP request header name
    
    Returns:
    
    HTTP request header value or null if no match is found
    
    Since:
    
    2.3.0
  - getRequestHeaders
```
@Deprecated
public String[] getRequestHeaders()
```
    Deprecated. Since 2.8.0 use getRequestHeaderNames()
    
    Gets all HTTP request header names for headers previously set with setRequestHeader(String, String). If no request headers are set, it returns an empty array.
    
    Returns:
    
    HTTP request header names
    
    Since:
    
    2.3.0
  - getRequestHeaderNames
```
public String[] getRequestHeaderNames()
```
    Gets all HTTP request header names for headers previously set with setRequestHeader(String, String). If no request headers are set, it returns an empty array.
    
    Returns:
    
    HTTP request header names
    
    Since:
    
    2.8.0
  - removeRequestHeader
```
public String removeRequestHeader(String name)
```
    Remove the request header matching the given name.
    
    Parameters:
    
    name - name of HTTP request header to remove
    
    Returns:
    
    the previous value associated with the name, or null if there was no request header for the name.
    
    Since:
    
    2.8.0
  - getAuthMethod
```
public String getAuthMethod()
```
    Gets the authentication method.
    
    Returns:
    
    authentication method
  - setAuthMethod
```
public void setAuthMethod(String authMethod)
```
    Sets the authentication method.
    
    Valid values are (case insensitive):
    - form
    - basic
    - digest
    - ntlm
    Experimental (not fully tested, please report):
    - spnego
    - kerberos
    Parameters:
    
    authMethod - authentication method
  - getAuthUsernameField
```
public String getAuthUsernameField()
```
    Gets the name of the HTML field where the username is set. This is used only for "form" authentication.
    
    Returns:
    
    username name of the HTML field
  - setAuthUsernameField
```
public void setAuthUsernameField(String authUsernameField)
```
    Sets the name of the HTML field where the username is set. This is used only for "form" authentication.
    
    Parameters:
    
    authUsernameField - name of the HTML field
  - getAuthUsername
```
public String getAuthUsername()
```
    Gets the username. Used for all authentication methods.
    
    Returns:
    
    username
  - setAuthUsername
```
public void setAuthUsername(String authUsername)
```
    Sets the username. Used for all authentication methods.
    
    Parameters:
    
    authUsername - username
  - getAuthPasswordField
```
public String getAuthPasswordField()
```
    Gets the name of the HTML field where the password is set. This is used only for "form" authentication.
    
    Returns:
    
    name of the HTML field
  - setAuthPasswordField
```
public void setAuthPasswordField(String authPasswordField)
```
    Sets the name of the HTML field where the password is set. This is used only for "form" authentication.
    
    Parameters:
    
    authPasswordField - name of the HTML field
  - getAuthPassword
```
public String getAuthPassword()
```
    Gets the authentication password. Used for all authentication methods.
    
    Returns:
    
    the password
  - setAuthPassword
```
public void setAuthPassword(String authPassword)
```
    Sets the authentication password. Used for all authentication methods.
    
    Parameters:
    
    authPassword - password
  - getAuthPasswordKey
```
public EncryptionKey getAuthPasswordKey()
```
    Gets the authentication password encryption key.
    
    Returns:
    
    the password key or null if the password is not encrypted.
    
    Since:
    
    2.4.0
    
    See Also:
    
    EncryptionUtil
  - setAuthPasswordKey
```
public void setAuthPasswordKey(EncryptionKey authPasswordKey)
```
    Sets the authentication password encryption key. Only required when the password is encrypted.
    
    Parameters:
    
    authPasswordKey - password key
    
    Since:
    
    2.4.0
    
    See Also:
    
    EncryptionUtil
  - isCookiesDisabled
```
public boolean isCookiesDisabled()
```
    Whether cookie support is disabled.
    
    Returns:
    
    true if disabled
  - setCookiesDisabled
```
public void setCookiesDisabled(boolean cookiesDisabled)
```
    Sets whether cookie support is disabled.
    
    Parameters:
    
    cookiesDisabled - true if disabled
  - getCookieSpec
```
public String getCookieSpec()
```
    Returns:
    
    the cookieSpec to use as defined in CookieSpecs
  - setCookieSpec
```
public void setCookieSpec(String cookieSpec)
```
    Parameters:
    
    cookieSpec - the cookieSpec to use as defined in CookieSpecs
  - getAuthURL
```
public String getAuthURL()
```
    Gets the URL for "form" authentication. The username and password will be POSTed to this URL. This is used only for "form" authentication.
    
    Returns:
    
    "form" authentication URL
  - setAuthURL
```
public void setAuthURL(String authURL)
```
    Sets the URL for "form" authentication. The username and password will be POSTed to this URL. This is used only for "form" authentication.
    
    Parameters:
    
    authURL - "form" authentication URL
  - getAuthHostname
```
public String getAuthHostname()
```
    Gets the host name for the current authentication scope. null means any host names for the scope. Used for BASIC and DIGEST authentication.
    
    Returns:
    
    hostname for the scope
  - setAuthHostname
```
public void setAuthHostname(String authHostname)
```
    Sets the host name for the current authentication scope. Setting this to null (default value) indicates "any hostname" for the scope. Used for BASIC and DIGEST authentication.
    
    Parameters:
    
    authHostname - hostname for the scope
  - getAuthPort
```
public int getAuthPort()
```
    Gets the port for the current authentication scope. A negative number indicates "any port" for the scope. Used for BASIC and DIGEST authentication.
    
    Returns:
    
    port for the scope
  - setAuthPort
```
public void setAuthPort(int authPort)
```
    Sets the port for the current authentication scope. Setting this to a negative number (default value) indicates "any port" for the scope. Used for BASIC and DIGEST authentication.
    
    Parameters:
    
    authPort - port for the scope
  - getAuthRealm
```
public String getAuthRealm()
```
    Gets the realm name for the current authentication scope. null indicates "any realm" for the scope. Used for BASIC and DIGEST authentication.
    
    Returns:
    
    realm name for the scope
  - setAuthRealm
```
public void setAuthRealm(String authRealm)
```
    Sets the realm name for the current authentication scope. Setting this to null (the default value) indicates "any realm" for the scope. Used for BASIC and DIGEST authentication.
    
    Parameters:
    
    authRealm - reaml name for the scope
  - getAuthFormCharset
```
public String getAuthFormCharset()
```
    Gets the authentication form character set.
    
    Returns:
    
    authentication form character set
  - setAuthFormCharset
```
public void setAuthFormCharset(String authFormCharset)
```
    Sets the authentication form character set for the form field values. Default is UTF-8.
    
    Parameters:
    
    authFormCharset - authentication form character set
  - isTrustAllSSLCertificates
```
public boolean isTrustAllSSLCertificates()
```
    Whether to trust all SSL certificates (affects only "https" connections).
    
    Returns:
    
    true if trusting all SSL certificates
    
    Since:
    
    1.3.0
  - setTrustAllSSLCertificates
```
public void setTrustAllSSLCertificates(boolean trustAllSSLCertificates)
```
    Sets whether to trust all SSL certificate. This is typically a bad idea (favors man-in-the-middle attacks) . Try to install a SSL certificate locally to ensure a proper certificate exchange instead.
    
    Parameters:
    
    trustAllSSLCertificates - true if trusting all SSL certificates
    
    Since:
    
    1.3.0
  - getProxyHost
```
public String getProxyHost()
```
    Gets the proxy host.
    
    Returns:
    
    proxy host
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets the proxy host.
    
    Parameters:
    
    proxyHost - proxy host
  - getProxyPort
```
public int getProxyPort()
```
    Gets the proxy port.
    
    Returns:
    
    proxy port
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Sets the proxy port.
    
    Parameters:
    
    proxyPort - proxy port
  - getProxyScheme
```
public String getProxyScheme()
```
    Gets the proxy scheme.
    
    Returns:
    
    proxy scheme
  - setProxyScheme
```
public void setProxyScheme(String proxyScheme)
```
    Sets the proxy scheme.
    
    Parameters:
    
    proxyScheme - proxy scheme
  - getProxyUsername
```
public String getProxyUsername()
```
    Gets the proxy username.
    
    Returns:
    
    proxy username
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Sets the proxy username
    
    Parameters:
    
    proxyUsername - proxy username
  - getProxyPassword
```
public String getProxyPassword()
```
    Gets the proxy password.
    
    Returns:
    
    proxy password
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Sets the proxy password.
    
    Parameters:
    
    proxyPassword - proxy password
  - getProxyPasswordKey
```
public EncryptionKey getProxyPasswordKey()
```
    Gets the proxy password encryption key.
    
    Returns:
    
    the password key or null if the password is not encrypted.
    
    Since:
    
    2.4.0
    
    See Also:
    
    EncryptionUtil
  - setProxyPasswordKey
```
public void setProxyPasswordKey(EncryptionKey proxyPasswordKey)
```
    Sets the proxy password encryption key. Only required when the password is encrypted.
    
    Parameters:
    
    proxyPasswordKey - password key
    
    Since:
    
    2.4.0
    
    See Also:
    
    EncryptionUtil
  - getProxyRealm
```
public String getProxyRealm()
```
    Gets the proxy realm.
    
    Returns:
    
    proxy realm
  - setProxyRealm
```
public void setProxyRealm(String proxyRealm)
```
    Sets the proxy realm
    
    Parameters:
    
    proxyRealm - proxy realm
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Gets the connection timeout until a connection is established, in milliseconds.
    
    Returns:
    
    connection timeout
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    Sets the connection timeout until a connection is established, in milliseconds. Default is DEFAULT_TIMEOUT.
    
    Parameters:
    
    connectionTimeout - connection timeout
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Gets the maximum period of inactivity between two consecutive data packets, in milliseconds.
    
    Returns:
    
    connection timeout
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
```
    Sets the maximum period of inactivity between two consecutive data packets, in milliseconds. Default is DEFAULT_TIMEOUT.
    
    Parameters:
    
    socketTimeout - socket timeout
  - getConnectionRequestTimeout
```
public int getConnectionRequestTimeout()
```
    Gets the timeout when requesting a connection, in milliseconds
    
    Returns:
    
    connection timeout
  - setConnectionRequestTimeout
```
public void setConnectionRequestTimeout(int connectionRequestTimeout)
```
    Sets the timeout when requesting a connection, in milliseconds. Default is DEFAULT_TIMEOUT.
    
    Parameters:
    
    connectionRequestTimeout - connection request timeout
  - getConnectionCharset
```
public String getConnectionCharset()
```
    Gets the connection character set.
    
    Returns:
    
    connection character set
  - setConnectionCharset
```
public void setConnectionCharset(String connectionCharset)
```
    Sets the connection character set. The HTTP protocol specification mandates the use of ASCII for HTTP message headers. Sites do not always respect this and it may be necessary to force a non-standard character set.
    
    Parameters:
    
    connectionCharset - connection character set
  - isExpectContinueEnabled
```
public boolean isExpectContinueEnabled()
```
    Whether 'Expect: 100-continue' handshake is enabled.
    
    Returns:
    
    true if enabled
  - setExpectContinueEnabled
```
public void setExpectContinueEnabled(boolean expectContinueEnabled)
```
    Sets whether 'Expect: 100-continue' handshake is enabled. See RequestConfig.isExpectContinueEnabled()
    
    Parameters:
    
    expectContinueEnabled - true if enabled
  - getMaxRedirects
```
public int getMaxRedirects()
```
    Gets the maximum number of redirects to be followed.
    
    Returns:
    
    maximum number of redirects to be followed
  - setMaxRedirects
```
public void setMaxRedirects(int maxRedirects)
```
    Sets the maximum number of redirects to be followed. This can help prevent infinite loops. A value of zero effectively disables redirects. Default is DEFAULT_MAX_REDIRECT.
    
    Parameters:
    
    maxRedirects - maximum number of redirects to be followed
  - getLocalAddress
```
public String getLocalAddress()
```
    Gets the local address (IP or hostname).
    
    Returns:
    
    local address
  - setLocalAddress
```
public void setLocalAddress(String localAddress)
```
    Sets the local address, which may be useful when working with multiple network interfaces.
    
    Parameters:
    
    localAddress - locale address
  - isStaleConnectionCheckDisabled
```
@Deprecated
public boolean isStaleConnectionCheckDisabled()
```
    Deprecated. Since 2.1.0. As of 2.2.0, use getMaxConnectionInactiveTime() instead.
    
    Gets whether stale connection check is disabled.
    
    Returns:
    
    true if stale connection check is disabled
  - setStaleConnectionCheckDisabled
```
@Deprecated
public void setStaleConnectionCheckDisabled(boolean staleConnectionCheckDisabled)
```
    Deprecated. Since 2.1.0. As of 2.2.0, use setMaxConnectionInactiveTime(int) instead.
    
    Sets whether stale connection check is disabled. Disabling stale connection check can slightly improve performance.
    
    Parameters:
    
    staleConnectionCheckDisabled - true if stale connection check is disabled
  - getAuthWorkstation
```
public String getAuthWorkstation()
```
    Gets the NTLM authentication workstation name.
    
    Returns:
    
    workstation name
  - setAuthWorkstation
```
public void setAuthWorkstation(String authWorkstation)
```
    Sets the NTLM authentication workstation name.
    
    Parameters:
    
    authWorkstation - workstation name
  - getAuthDomain
```
public String getAuthDomain()
```
    Gets the NTLM authentication domain.
    
    Returns:
    
    authentication domain
  - setAuthDomain
```
public void setAuthDomain(String authDomain)
```
    Sets the NTLM authentication domain
    
    Parameters:
    
    authDomain - authentication domain
  - getMaxConnections
```
public int getMaxConnections()
```
    Gets the maximum number of connections that can be created.
    
    Returns:
    
    number of connections
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    Sets maximum number of connections that can be created. Typically, you would have at least the same amount as threads. Default is DEFAULT_MAX_CONNECTIONS.
    
    Parameters:
    
    maxConnections - maximum number of connections
  - getMaxConnectionsPerRoute
```
public int getMaxConnectionsPerRoute()
```
    Gets the maximum number of connections that can be used per route.
    
    Returns:
    
    number of connections per route
    
    Since:
    
    2.2.0
  - setMaxConnectionsPerRoute
```
public void setMaxConnectionsPerRoute(int maxConnectionsPerRoute)
```
    Sets the maximum number of connections that can be used per route. Default is DEFAULT_MAX_CONNECTIONS_PER_ROUTE.
    
    Parameters:
    
    maxConnectionsPerRoute - maximum number of connections per route
    
    Since:
    
    2.2.0
  - getMaxConnectionIdleTime
```
public int getMaxConnectionIdleTime()
```
    Gets the period of time in milliseconds after which to evict idle connections from the connection pool.
    
    Returns:
    
    amount of time after which to evict idle connections
    
    Since:
    
    2.2.0
  - setMaxConnectionIdleTime
```
public void setMaxConnectionIdleTime(int maxConnectionIdleTime)
```
    Sets the period of time in milliseconds after which to evict idle connections from the connection pool. Default is DEFAULT_MAX_IDLE_TIME.
    
    Parameters:
    
    maxConnectionIdleTime - amount of time after which to evict idle connections
    
    Since:
    
    2.2.0
  - getMaxConnectionInactiveTime
```
public int getMaxConnectionInactiveTime()
```
    Gets the period of time in milliseconds a connection must be inactive to be checked in case it became stalled.
    
    Returns:
    
    period of time in milliseconds
    
    Since:
    
    2.2.0
  - setMaxConnectionInactiveTime
```
public void setMaxConnectionInactiveTime(int maxConnectionInactiveTime)
```
    Sets the period of time in milliseconds a connection must be inactive to be checked in case it became stalled. Default is 0 (not proactively checked).
    
    Parameters:
    
    maxConnectionInactiveTime - period of time in milliseconds
    
    Since:
    
    2.2.0
  - getSSLProtocols
```
public String[] getSSLProtocols()
```
    Gets the supported SSL/TLS protocols. Default is null, which means it will use those provided/configured by your Java platform.
    
    Returns:
    
    SSL/TLS protocols
    
    Since:
    
    2.6.2
  - setSSLProtocols
```
public void setSSLProtocols(String... sslProtocols)
```
    Sets the supported SSL/TLS protocols, such as SSLv3, TLSv1, TLSv1.1, and TLSv1.2. Note that specifying a protocol not supported by your underlying Java platform will not work.
    
    Parameters:
    
    sslProtocols - SSL/TLS protocols supported
    
    Since:
    
    2.6.2
  - setAuthFormParam
```
public void setAuthFormParam(String name,
                             String value)
```
    Sets an authentication form parameter (equivalent to "input" or other fields in HTML forms).
    
    Parameters:
    
    name - form parameter name
    
    value - form parameter value
    
    Since:
    
    2.8.0
  - getAuthFormParam
```
public String getAuthFormParam(String name)
```
    Gets an authentication form parameter (equivalent to "input" or other fields in HTML forms).
    
    Parameters:
    
    name - form parameter name
    
    Returns:
    
    form parameter value or null if no match is found
    
    Since:
    
    2.8.0
  - getAuthFormParamNames
```
public String[] getAuthFormParamNames()
```
    Gets all authentication form parameter names. If no form parameters are set, it returns an empty array.
    
    Returns:
    
    HTTP request header names
    
    Since:
    
    2.8.0
  - removeAuthFormParameter
```
public String removeAuthFormParameter(String name)
```
    Remove the authentication form parameter matching the given name.
    
    Parameters:
    
    name - name of form parameter to remove
    
    Returns:
    
    the previous value associated with the name, or null if there was no form parameter for the name.
    
    Since:
    
    2.8.0
  - isAuthPreemptive
```
public boolean isAuthPreemptive()
```
    Gets whether to perform preemptive authentication (valid for "basic" authentication method).
    
    Returns:
    
    true to perform preemptive authentication
    
    Since:
    
    2.8.0
  - setAuthPreemptive
```
public void setAuthPreemptive(boolean authPreemptive)
```
    Sets whether to perform preemptive authentication (valid for "basic" authentication method).
    
    Parameters:
    
    authPreemptive - true to perform preemptive authentication
    
    Since:
    
    2.8.0
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GenericHttpClientFactory

Password encryption in XML configuration:

XML configuration usage:

Usage example:

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTH_METHOD_FORM

AUTH_METHOD_BASIC

AUTH_METHOD_DIGEST

AUTH_METHOD_NTLM

AUTH_METHOD_SPNEGO

AUTH_METHOD_KERBEROS

DEFAULT_TIMEOUT

DEFAULT_MAX_REDIRECT

DEFAULT_MAX_CONNECTIONS

DEFAULT_MAX_CONNECTIONS_PER_ROUTE

DEFAULT_MAX_IDLE_TIME

Constructor Detail

GenericHttpClientFactory

Method Detail

createHTTPClient

buildCustomHttpClient

authenticateUsingForm

createDefaultCookieStore

createDefaultRequestHeaders

createRedirectStrategy

createSchemePortResolver

createRequestConfig

createProxy

createCredentialsProvider

createConnectionConfig

createSSLSocketFactory

createSSLContext

loadFromXML

saveToXML

setRequestHeader

getRequestHeader

getRequestHeaders

getRequestHeaderNames

removeRequestHeader

getAuthMethod

setAuthMethod

getAuthUsernameField

setAuthUsernameField

getAuthUsername

setAuthUsername

getAuthPasswordField

setAuthPasswordField

getAuthPassword

setAuthPassword

getAuthPasswordKey

setAuthPasswordKey

isCookiesDisabled

setCookiesDisabled

getCookieSpec

setCookieSpec

getAuthURL

setAuthURL

getAuthHostname

setAuthHostname

getAuthPort

setAuthPort

getAuthRealm

setAuthRealm

getAuthFormCharset

setAuthFormCharset

isTrustAllSSLCertificates

setTrustAllSSLCertificates

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyScheme

setProxyScheme

getProxyUsername

setProxyUsername

getProxyPassword