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 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	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	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	REQUEST_CONFIG Request configuration for the HttpClient.
static String	SSL_CONFIG Support for specifying SSL configuration for HTTPS connections.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	getValue(Map<String,?> properties, String key, Class<T> type) Get the value of the specified property.

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

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

Method Detail

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