com.sun.jersey.client.apache.config
Interface ApacheHttpClientConfig

All Superinterfaces:
ClientConfig, FeaturesAndProperties
All Known Implementing Classes:
DefaultApacheHttpClientConfig

public interface ApacheHttpClientConfig
extends ClientConfig

Configuration options specific to the Client API that utilizes ApacheHttpClient or ApacheHttpClientHandler.

Author:
jorgeluisw@mac.com, Paul.Sandoz@Sun.Com

Field Summary
static java.lang.String PROPERTY_CREDENTIALS_PROVIDER
          The credential provider that should be used to retrieve credentials from a user.
static java.lang.String PROPERTY_HANDLE_COOKIES
          A value of "true" indicates the client should handle cookies automatically using HttpClient's default cookie policy.
static java.lang.String PROPERTY_HTTP_STATE
          The ApacheHttpClientState of the current client.
static java.lang.String PROPERTY_INTERACTIVE
          A value of "true" indicates that the client should interactively prompt for credentials should it receive a 401 response.
static java.lang.String PROPERTY_PREEMPTIVE_AUTHENTICATION
          A value of "true" indicates that a client should send an authentication request even before the server gives a 401 response.
static java.lang.String PROPERTY_PROXY_URI
          A value of a URI to configure the proxy host and proxy port to proxy HTTP requests and responses.
 
Fields inherited from interface com.sun.jersey.api.client.config.ClientConfig
PROPERTY_BUFFER_RESPONSE_ENTITY_ON_EXCEPTION, PROPERTY_CHUNKED_ENCODING_SIZE, PROPERTY_CONNECT_TIMEOUT, PROPERTY_FOLLOW_REDIRECTS, PROPERTY_READ_TIMEOUT
 
Fields inherited from interface com.sun.jersey.core.util.FeaturesAndProperties
FEATURE_DISABLE_XML_SECURITY, FEATURE_FORMATTED
 
Method Summary
 ApacheHttpClientState getState()
          Get the HTTP state.
 
Methods inherited from interface com.sun.jersey.api.client.config.ClientConfig
getClasses, getPropertyAsFeature, getSingletons
 
Methods inherited from interface com.sun.jersey.core.util.FeaturesAndProperties
getFeature, getFeatures, getProperties, getProperty
 

Field Detail

PROPERTY_INTERACTIVE

static final java.lang.String PROPERTY_INTERACTIVE
A value of "true" indicates that the client should interactively prompt for credentials should it receive a 401 response. The value MUST be an instance of Boolean. If the property is absent the default value is "false"

See Also:
Constant Field Values

PROPERTY_HANDLE_COOKIES

static final java.lang.String PROPERTY_HANDLE_COOKIES
A value of "true" indicates the client should handle cookies automatically using HttpClient's default cookie policy. A value of "false" will cause the client to ignore all cookies. The value MUST be an instance of Boolean. If the property is absent the default value is "false"

See Also:
Constant Field Values

PROPERTY_CREDENTIALS_PROVIDER

static final java.lang.String PROPERTY_CREDENTIALS_PROVIDER
The credential provider that should be used to retrieve credentials from a user. The provider will be used only if PROPERTY_INTERACTIVE is set to true. The value MUST be an instance of CredentialsProvider. If the property is absent a default provider will be used.

See Also:
Constant Field Values

PROPERTY_PREEMPTIVE_AUTHENTICATION

static final java.lang.String PROPERTY_PREEMPTIVE_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 ApacheHttpClient instance. If the value of this property is set to "true" default credientials must be set for the target or proxy. The value MUST be an instance of Boolean. If the property is absent the default value is "false"

See Also:
Constant Field Values

PROPERTY_PROXY_URI

static final java.lang.String PROPERTY_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 be selected. The value MUST be an instance of String or URI. If the property absent then no proxy will be utilized.

See Also:
Constant Field Values

PROPERTY_HTTP_STATE

static final java.lang.String PROPERTY_HTTP_STATE
The ApacheHttpClientState of the current client. This is used to maintain authentication credentials. The value MUST be an instance of ApacheHttpClientState.

See Also:
Constant Field Values
Method Detail

getState

ApacheHttpClientState getState()
Get the HTTP state. Credentials may be set on the HTTP state.

If no state exists then an instance is created and added as the property PROPERTY_HTTP_STATE.

Returns:
the HTTP state.


Copyright © 2011 Sun Microsystems, Inc. All Rights Reserved.