|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.client.params.HttpClientParams
public class HttpClientParams
An adaptor for accessing HTTP client parameters in HttpParams
.
Field Summary | |
---|---|
static java.lang.String |
ALLOW_CIRCULAR_REDIRECTS
Defines whether circular redirects (redirects to the same location) should be allowed. |
static java.lang.String |
AUTH_SCHEME_PRIORITY
The key used to look up the list of IDs of supported authentication schemes in their order of preference. |
static java.lang.String |
CONNECTION_MANAGER_FACTORY
Defines the class name of the default ClientConnectionManager |
static java.lang.String |
CONNECTION_MANAGER_TIMEOUT
Defines the timeout in milliseconds used when retrieving an instance of ManagedClientConnection from the
ClientConnectionManager . |
static java.lang.String |
COOKIE_POLICY
Defines the name of the cookie specification to be used for HTTP state management. |
static java.lang.String |
DEFAULT_HEADERS
Defines the request headers to be sent per default with each request. |
static java.lang.String |
DEFAULT_HOST
Defines the default host. |
static java.lang.String |
DEFAULT_PROXY
Defines the default proxy. |
static java.lang.String |
HANDLE_AUTHENTICATION
Defines whether authentication should be handled automatically. |
static java.lang.String |
HANDLE_REDIRECTS
Defines whether redirects should be handled automatically |
static java.lang.String |
MAX_REDIRECTS
Defines the maximum number of redirects to be followed. |
static java.lang.String |
PREEMPTIVE_AUTHENTICATION
Defines whether authentication should be attempted preemptively. |
static java.lang.String |
REJECT_RELATIVE_REDIRECT
Defines whether relative redirects should be rejected. |
static java.lang.String |
VIRTUAL_HOST
Defines the virtual host name. |
Method Summary | |
---|---|
static long |
getConnectionManagerTimeout(org.apache.http.params.HttpParams params)
Returns the timeout in milliseconds used when retrieving a ManagedClientConnection from the
ClientConnectionManager . |
static java.lang.String |
getCookiePolicy(org.apache.http.params.HttpParams params)
|
static boolean |
isAuthenticating(org.apache.http.params.HttpParams params)
|
static boolean |
isAuthenticationPreemptive(org.apache.http.params.HttpParams params)
Returns true if authentication should be attempted preemptively, false otherwise. |
static boolean |
isRedirecting(org.apache.http.params.HttpParams params)
|
static void |
setAuthenticating(org.apache.http.params.HttpParams params,
boolean value)
|
static void |
setAuthenticationPreemptive(org.apache.http.params.HttpParams params,
boolean value)
Sets whether authentication should be attempted preemptively. |
static void |
setConnectionManagerTimeout(org.apache.http.params.HttpParams params,
long timeout)
Sets the timeout in milliseconds used when retrieving a ManagedClientConnection from the
ClientConnectionManager . |
static void |
setCookiePolicy(org.apache.http.params.HttpParams params,
java.lang.String cookiePolicy)
|
static void |
setRedirecting(org.apache.http.params.HttpParams params,
boolean value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONNECTION_MANAGER_TIMEOUT
ManagedClientConnection
from the
ClientConnectionManager
.
This parameter expects a value of type Long
.
public static final java.lang.String CONNECTION_MANAGER_FACTORY
ClientConnectionManager
This parameter expects a value of type String
.
public static final java.lang.String HANDLE_REDIRECTS
This parameter expects a value of type Boolean
.
public static final java.lang.String REJECT_RELATIVE_REDIRECT
This parameter expects a value of type Boolean
.
public static final java.lang.String MAX_REDIRECTS
This parameter expects a value of type Integer
.
public static final java.lang.String ALLOW_CIRCULAR_REDIRECTS
This parameter expects a value of type Boolean
.
public static final java.lang.String HANDLE_AUTHENTICATION
This parameter expects a value of type Boolean
.
public static final java.lang.String PREEMPTIVE_AUTHENTICATION
This parameter expects a value of type Boolean
.
public static final java.lang.String AUTH_SCHEME_PRIORITY
authentication schemes
in their order of preference.
The scheme IDs are stored in a Collection
as
instances of String
.
If several schemes are returned in the WWW-Authenticate
or Proxy-Authenticate header, this parameter defines which
authentication schemes
takes precedence over others.
The first item in the collection represents the most preferred
authentication scheme
, the last item represents
the ID of the least preferred one.
public static final java.lang.String COOKIE_POLICY
This parameter expects a value of type String
.
public static final java.lang.String VIRTUAL_HOST
This parameter expects a value of type HttpHost
.
public static final java.lang.String DEFAULT_HEADERS
This parameter expects a value of type Collection
. The
collection is expected to contain Header
s.
public static final java.lang.String DEFAULT_HOST
This parameter expects a value of type HttpHost
.
public static final java.lang.String DEFAULT_PROXY
This parameter expects a value of type HttpHost
.
Method Detail |
---|
public static long getConnectionManagerTimeout(org.apache.http.params.HttpParams params)
ManagedClientConnection
from the
ClientConnectionManager
.
public static void setConnectionManagerTimeout(org.apache.http.params.HttpParams params, long timeout)
ManagedClientConnection
from the
ClientConnectionManager
.
timeout
- the timeout in millisecondspublic static boolean isRedirecting(org.apache.http.params.HttpParams params)
public static void setRedirecting(org.apache.http.params.HttpParams params, boolean value)
public static boolean isAuthenticating(org.apache.http.params.HttpParams params)
public static void setAuthenticating(org.apache.http.params.HttpParams params, boolean value)
public static boolean isAuthenticationPreemptive(org.apache.http.params.HttpParams params)
public static void setAuthenticationPreemptive(org.apache.http.params.HttpParams params, boolean value)
value
- true if authentication should be attempted preemptively,
false otherwise.public static java.lang.String getCookiePolicy(org.apache.http.params.HttpParams params)
public static void setCookiePolicy(org.apache.http.params.HttpParams params, java.lang.String cookiePolicy)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |