ApacheClientProperties (Jersey 2.5.2 API)

java.lang.Object
- org.glassfish.jersey.apache.connector.ApacheClientProperties

```
public final class ApacheClientProperties
extends Object
```
Configuration options specific to the Client API that utilizes ApacheConnectorProvider.

Author:

jorgeluisw@mac.com, Paul Sandoz (paul.sandoz at oracle.com), Pavel Bucek (pavel.bucek at oracle.com), Arul Dhesiaseelan (aruld at acm.org)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONNECTION_MANAGER` Connection Manager which will be used to create `HttpClient`.
`static String`	`CONNECTION_MANAGER_SHARED` A value of `true` indicates that configured connection manager should be shared among multiple Jersey `ClientRuntime` instances.
`static String`	`CREDENTIALS_PROVIDER` The credential provider that should be used to retrieve credentials from a user.
`static String`	`DISABLE_COOKIES` A value of `false` indicates the client should handle cookies automatically using HttpClient's default cookie policy.
`static String`	`HTTP_PARAMS` Deprecated. Use `REQUEST_CONFIG` instead. Will be removed in one of the next releases.
`static String`	`PREEMPTIVE_BASIC_AUTHENTICATION` A value of `true` indicates that a client should send an authentication request even before the server gives a 401 response.
`static String`	`PROXY_PASSWORD` Deprecated. Use `ClientProperties.PROXY_PASSWORD` instead. Will be removed in one of the next releases.
`static String`	`PROXY_URI` Deprecated. Use `ClientProperties.PROXY_URI` instead. Will be removed in one of the next releases.
`static String`	`PROXY_USERNAME` Deprecated. Use `ClientProperties.PROXY_USERNAME` instead. Will be removed in one of the next releases.
`static String`	`REQUEST_CONFIG` Request configuration for the `HttpClient`.
`static String`	`SSL_CONFIG` Support for specifying SSL configuration for HTTPS connections.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SSL_CONFIG
```
public static final String SSL_CONFIG
```
    Support for specifying SSL configuration for HTTPS connections. Used only when making HTTPS requests.
    The value MUST be an instance of SslConfigurator.
    A default value is not set.
    The name of the configuration property is "jersey.config.apache.client.ssl.sslConfig".
    
    See Also:
    Constant Field Values
  - CREDENTIALS_PROVIDER
```
public static final String CREDENTIALS_PROVIDER
```
    The credential provider that should be used to retrieve credentials from a user. Credentials needed for proxy authentication are stored here as well.
    The value MUST be an instance of CredentialsProvider.
    If the property is absent a default provider will be used.
    The name of the configuration property is "jersey.config.apache.client.credentialsProvider".
    
    See Also:
    Constant Field Values
  - DISABLE_COOKIES
```
public static final String DISABLE_COOKIES
```
    A value of false indicates the client should handle cookies automatically using HttpClient's default cookie policy. A value of true will cause the client to ignore all cookies.
    The value MUST be an instance of Boolean.
    The default value is false.
    The name of the configuration property is "jersey.config.apache.client.handleCookies".
    
    See Also:
    Constant Field Values
  - PREEMPTIVE_BASIC_AUTHENTICATION
```
public static final String PREEMPTIVE_BASIC_AUTHENTICATION
```
    A value of true indicates that a client should send an authentication request even before the server gives a 401 response.
    This property may only be set prior to constructing Apache connector using ApacheConnectorProvider.
    The value MUST be an instance of Boolean.
    The default value is false.
    The name of the configuration property is "jersey.config.apache.client.preemptiveBasicAuthentication".
    
    See Also:
    Constant Field Values
  - CONNECTION_MANAGER
```
public static final String CONNECTION_MANAGER
```
    Connection Manager which will be used to create HttpClient.
    The value MUST be an instance of HttpClientConnectionManager.
    If the property is absent a default Connection Manager will be used (BasicHttpClientConnectionManager). If you want to use this client in multi-threaded environment, be sure you override default value with PoolingHttpClientConnectionManager instance.
    The name of the configuration property is "jersey.config.apache.client.connectionManager".
    
    See Also:
    Constant Field Values
  - CONNECTION_MANAGER_SHARED
```
public static final String CONNECTION_MANAGER_SHARED
```
    A value of true indicates that configured connection manager should be shared among multiple Jersey ClientRuntime instances. It means that closing a particular ClientRuntime instance does not shut down the underlying connection manager automatically. In such case, the connection manager life-cycle should be fully managed by the application code. To release all allocated resources, caller code should especially ensure HttpClientConnectionManager.shutdown() gets invoked eventually.
    This property may only be set prior to constructing Apache connector using ApacheConnectorProvider.
    The value MUST be an instance of Boolean.
    The default value is false.
    The name of the configuration property is "jersey.config.apache.client.connectionManagerShared".
    
    Since:
    
    2.5.2 (on 2.5.x branch, since 2.18 on the master branch)
    
    See Also:
    Constant Field Values
  - HTTP_PARAMS
```
@Deprecated
public static final String HTTP_PARAMS
```
    Deprecated. Use REQUEST_CONFIG instead. Will be removed in one of the next releases.
    
    Request configuration for the HttpClient. Http parameters which will be used to create HttpClient.
    The value MUST be an instance of HttpParams.
    If the property is absent default http parameters will be used.
    The name of the configuration property is "jersey.config.apache.client.httpParams".
    
    See Also:
    Constant Field Values
  - PROXY_URI
```
@Deprecated
public static final String PROXY_URI
```
    Deprecated. Use ClientProperties.PROXY_URI instead. Will be removed in one of the next releases.
    
    A value of a URI to configure the proxy host and proxy port to proxy HTTP requests and responses. If the port component of the URI is absent then a default port of 8080 will be selected.
    The value MUST be an instance of String or URI.
    If the property absent then no proxy will be utilized.
    The name of the configuration property is "jersey.config.apache.client.proxyUri".
    
    See Also:
    Constant Field Values
  - PROXY_USERNAME
```
@Deprecated
public static final String PROXY_USERNAME
```
    Deprecated. Use ClientProperties.PROXY_USERNAME instead. Will be removed in one of the next releases.
    
    User name which will be used for proxy authentication.
    The value MUST be an instance of String.
    If the property absent then no proxy authentication will be utilized.
    The name of the configuration property is "jersey.config.apache.client.proxyUsername".
    
    See Also:
    Constant Field Values
  - PROXY_PASSWORD
```
@Deprecated
public static final String PROXY_PASSWORD
```
    Deprecated. Use ClientProperties.PROXY_PASSWORD instead. Will be removed in one of the next releases.
    
    Password which will be used for proxy authentication.
    The value MUST be an instance of String.
    If the property absent then no proxy authentication will be utilized.
    The name of the configuration property is "jersey.config.apache.client.proxyPassword".
    
    See Also:
    Constant Field Values
  - REQUEST_CONFIG
```
public static final String REQUEST_CONFIG
```
    Request configuration for the HttpClient.
    The value MUST be an instance of RequestConfig.
    If the property is absent default request configuration will be used.
    The name of the configuration property is "jersey.config.apache.client.requestConfig".
    
    Since:
    
    2.5
    
    See Also:
    Constant Field Values

Class ApacheClientProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSL_CONFIG

CREDENTIALS_PROVIDER

DISABLE_COOKIES

PREEMPTIVE_BASIC_AUTHENTICATION

CONNECTION_MANAGER

CONNECTION_MANAGER_SHARED

HTTP_PARAMS

PROXY_URI

PROXY_USERNAME

PROXY_PASSWORD

REQUEST_CONFIG