Class Apache5ClientProperties

java.lang.Object
org.glassfish.jersey.apache5.connector.Apache5ClientProperties

public final class Apache5ClientProperties extends Object
Configuration options specific to the Client API that utilizes Apache5ConnectorProvider.
Author:
jorgeluisw@mac.com, Paul Sandoz, Pavel Bucek, Arul Dhesiaseelan (aruld at acm.org), Steffen Nie├čing
  • Field Details

    • 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.apache5.client.credentialsProvider".

      See Also:
    • 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.apache5.client.handleCookies".

      See Also:
    • 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 Apache5ConnectorProvider.

      The value MUST be an instance of Boolean.

      The default value is false.

      The name of the configuration property is "jersey.config.apache5.client.preemptiveBasicAuthentication".

      See Also:
    • 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.apache5.client.connectionManager".

      See Also:
    • 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 Closeable.close() gets invoked eventually.

      This property may only be set prior to constructing Apache connector using Apache5ConnectorProvider.

      The value MUST be an instance of Boolean.

      The default value is false.

      The name of the configuration property is "jersey.config.apache5.client.connectionManagerShared".

      Since:
      2.18
      See Also:
    • REQUEST_CONFIG

      public static final String REQUEST_CONFIG
      Request configuration for the HttpClient. Http parameters which will be used to create 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.apache5.client.requestConfig".

      Since:
      2.5
      See Also:
    • RETRY_STRATEGY

      public static final String RETRY_STRATEGY
      HttpRequestRetryStrategy which will be used to create HttpClient.

      The value MUST be an instance of HttpRequestRetryStrategy.

      If the property is absent a default retry handler will be used (DefaultHttpRequestRetryStrategy).

      The name of the configuration property is "jersey.config.apache5.client.retryStrategy".

      See Also:
    • REUSE_STRATEGY

      public static final String REUSE_STRATEGY
      ConnectionReuseStrategy for the HttpClient.

      The value MUST be an instance of ConnectionReuseStrategy.

      If the property is absent the default reuse strategy of the Apache HTTP library will be used

      The name of the configuration property is "jersey.config.apache5.client.reuseStrategy".

      See Also:
    • KEEPALIVE_STRATEGY

      public static final String KEEPALIVE_STRATEGY
      ConnectionKeepAliveStrategy for the HttpClient.

      The value MUST be an instance of ConnectionKeepAliveStrategy.

      If the property is absent the default keepalive strategy of the Apache HTTP library will be used

      The name of the configuration property is "jersey.config.apache5.client.keepAliveStrategy".

      See Also:
    • CONNECTION_CLOSING_STRATEGY

      public static final String CONNECTION_CLOSING_STRATEGY
      Strategy that closes the Apache Connection. Accepts an instance of Apache5ConnectionClosingStrategy.
      Since:
      2.30
      See Also:
    • USE_SYSTEM_PROPERTIES

      public static final String USE_SYSTEM_PROPERTIES
      A value of false indicates the client will use default ApacheConnector params. A value of true will cause the client to take into account the system properties https.protocols, https.cipherSuites, http.keepAlive, http.maxConnections.

      The value MUST be an instance of Boolean.

      The default value is false.

      The name of the configuration property is "jersey.config.apache5.client.useSystemProperties".

      See Also:
  • Method Details

    • getValue

      public static <T> T getValue(Map<String,?> properties, String key, Class<T> type)
      Get the value of the specified property. If the property is not set or the actual property value type is not compatible with the specified type, the method will return null.
      Type Parameters:
      T - Type of the property value.
      Parameters:
      properties - Map of properties to get the property value from.
      key - Name of the property.
      type - Type to retrieve the value as.
      Returns:
      Value of the property or null.
      Since:
      2.8