org.glassfish.jersey.apache.connector
Class ApacheClientProperties

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

public final class ApacheClientProperties
extends Object

Configuration options specific to the Client API that utilizes ApacheConnector.

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

static String	CONNECTION_MANAGER Connection Manager which will be used to create HttpClient.
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 Http parameters which will be used to create HttpClient.
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 Password which will be used for proxy authentication.
static String	PROXY_URI A value of a URI to configure the proxy host and proxy port to proxy HTTP requests and responses.
static String	PROXY_USERNAME User name which will be used for proxy authentication.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 when constructing a ApacheConnector instance.

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 ClientConnectionManager.

If the property is absent a default Connection Manager will be used (org.apache.http.impl.conn.BasicClientConnectionManager). If you want to use this client in multi-threaded environment, be sure you override default value with org.apache.http.impl.conn.PoolingClientConnectionManager instance.

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

See Also:

Constant Field Values

HTTP_PARAMS

public static final String HTTP_PARAMS

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

public static final String PROXY_URI

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

public static final String PROXY_USERNAME

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

public static final String PROXY_PASSWORD

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