org.glassfish.jersey.client
Class ClientProperties

java.lang.Object
  extended by org.glassfish.jersey.client.ClientProperties

public final class ClientProperties
extends java.lang.Object

Jersey client implementation configuration properties.

Author:
Marek Potociar (marek.potociar at oracle.com)

Field Summary
static java.lang.String ASYNC_THREADPOOL_SIZE
          Asynchronous thread pool size.
static java.lang.String BUFFER_RESPONSE_ENTITY_ON_EXCEPTION
          Automatic response buffering in case of an exception.
static java.lang.String CHUNKED_ENCODING_SIZE
          Chunked encoding size.
static java.lang.String CONNECT_TIMEOUT
          Connect timeout interval, in milliseconds.
static java.lang.String FEATURE_DISABLE_AUTO_DISCOVERY
          If true then disable auto-discovery on the client.
static java.lang.String FEATURE_DISABLE_JSON_PROCESSING
          If true then disable registration of Json Processing (JSR-353) feature on client.
static java.lang.String FOLLOW_REDIRECTS
          Automatic redirection.
static java.lang.String HTTP_URL_CONNECTION_SET_METHOD_WORKAROUND
          A value of true declares that the client will try to set unsupported HTTP method to HttpURLConnection via reflection.
static java.lang.String READ_TIMEOUT
          Read timeout interval, in milliseconds.
static java.lang.String USE_ENCODING
          If EncodingFilter is registered, this property indicates the value of Content-Encoding property the filter should be adding.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FOLLOW_REDIRECTS

public static final java.lang.String FOLLOW_REDIRECTS
Automatic redirection. A value of true declares that the client will automatically redirect to the URI declared in 3xx responses. The value MUST be an instance convertible to Boolean.

The default value is true.

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

See Also:
Constant Field Values

READ_TIMEOUT

public static final java.lang.String READ_TIMEOUT
Read timeout interval, in milliseconds. The value MUST be an instance convertible to Integer. A value of zero (0) is equivalent to an interval of infinity.

The default value is infinity (0).

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

See Also:
Constant Field Values

CONNECT_TIMEOUT

public static final java.lang.String CONNECT_TIMEOUT
Connect timeout interval, in milliseconds. The value MUST be an instance convertible to Integer. A value of zero (0) is equivalent to an interval of infinity.

The default value is infinity (0).

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

See Also:
Constant Field Values

CHUNKED_ENCODING_SIZE

public static final java.lang.String CHUNKED_ENCODING_SIZE
Chunked encoding size. The value MUST be an instance convertible to Integer.

If the property is absent then chunked encoding will not be used. A value <= 0 declares that chunked encoding will be used with the default chunk size. A value > 0 declares that chunked encoding will be used with the value as the declared chunk size.

A default value is not set.

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

See Also:
Constant Field Values

BUFFER_RESPONSE_ENTITY_ON_EXCEPTION

public static final java.lang.String BUFFER_RESPONSE_ENTITY_ON_EXCEPTION
Automatic response buffering in case of an exception. A value of true declares that the client will automatically read & buffer the response entity (if any) and close all resources associated with the response. The value MUST be an instance convertible to Boolean.

The default value is true.

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

See Also:
Constant Field Values

ASYNC_THREADPOOL_SIZE

public static final java.lang.String ASYNC_THREADPOOL_SIZE
Asynchronous thread pool size. The value MUST be an instance of Integer.

If the property is absent then thread pool used for async requests will be initialized as default cached thread pool, which creates new thread for every new request, see Executors. When a value > 0 is provided, the created cached thread pool limited to that number of threads will be utilized.

A default value is not set.

The name of the configuration property is "jersey.config.client.async.threadPoolSize".

See Also:
Constant Field Values

USE_ENCODING

public static final java.lang.String USE_ENCODING
If EncodingFilter is registered, this property indicates the value of Content-Encoding property the filter should be adding.

The value MUST be an instance of String.

The default value is null.

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

See Also:
Constant Field Values

HTTP_URL_CONNECTION_SET_METHOD_WORKAROUND

public static final java.lang.String HTTP_URL_CONNECTION_SET_METHOD_WORKAROUND
A value of true declares that the client will try to set unsupported HTTP method to HttpURLConnection via reflection.

NOTE: Enabling this feature might cause security related warnings/errors and it might break when other JDK implementation is used. Use only when you know what you are doing.

The value MUST be an instance of Boolean.

The default value is false.

The name of the configuration property is "jersey.config.client.httpUrlConnection.setMethodWorkaround".

See Also:
Constant Field Values

FEATURE_DISABLE_AUTO_DISCOVERY

public static final java.lang.String FEATURE_DISABLE_AUTO_DISCOVERY
If true then disable auto-discovery on the client.

By default auto-discovery on client is automatically enabled if global property "jersey.config.disableAutoDiscovery" is not disabled. If set then the client property value overrides the global property value.

The default value is false.

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

See Also:
CommonProperties.FEATURE_DISABLE_AUTO_DISCOVERY, Constant Field Values

FEATURE_DISABLE_JSON_PROCESSING

public static final java.lang.String FEATURE_DISABLE_JSON_PROCESSING
If true then disable registration of Json Processing (JSR-353) feature on client.

By default Json Processing on client is automatically enabled if global property "jersey.config.disableJsonProcessing" is not disabled. If set then the client property value overrides the global property value.

The default value is false.

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

See Also:
CommonProperties.FEATURE_DISABLE_JSON_PROCESSING, Constant Field Values


Copyright © 2007-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.