org.apache.commons.httpclient.params: public class: HttpClientParams

org.apache.commons.httpclient.params
public class: HttpClientParams [javadoc | source]

java.lang.Object
   org.apache.commons.httpclient.params.DefaultHttpParams
      org.apache.commons.httpclient.params.HttpMethodParams
         org.apache.commons.httpclient.params.HttpClientParams

All Implemented Interfaces:
Cloneable, Serializable, HttpParams

This class represents a collection of HTTP protocol parameters applicable to instances of HttpClient . Protocol parameters may be linked together to form a hierarchy. If a particular parameter value has not been explicitly defined in the collection itself, its value will be drawn from the parent collection of parameters.

author: < - a href="mailto:oleg@ural.ru">Oleg Kalnichevski

version: $ - Revision: 480424 $

since: 3.0 -

Field Summary
public static final String	CONNECTION_MANAGER_TIMEOUT	Sets the timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager . This parameter expects a value of type Long .
public static final String	CONNECTION_MANAGER_CLASS	Defines the default HTTP connection manager class. This parameter expects a value of type Class .
public static final String	PREEMPTIVE_AUTHENTICATION	Defines whether authentication should be attempted preemptively. This parameter expects a value of type Boolean .
public static final String	REJECT_RELATIVE_REDIRECT	Defines whether relative redirects should be rejected. This parameter expects a value of type Boolean .
public static final String	MAX_REDIRECTS	Defines the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops. This parameter expects a value of type Integer .
public static final String	ALLOW_CIRCULAR_REDIRECTS	Defines whether circular redirects (redirects to the same location) should be allowed. The HTTP spec is not sufficiently clear whether circular redirects are permitted, therefore optionally they can be enabled This parameter expects a value of type Boolean .

Fields inherited from org.apache.commons.httpclient.params.HttpMethodParams:
USER_AGENT, PROTOCOL_VERSION, UNAMBIGUOUS_STATUS_LINE, SINGLE_COOKIE_HEADER, STRICT_TRANSFER_ENCODING, REJECT_HEAD_BODY, HEAD_BODY_CHECK_TIMEOUT, USE_EXPECT_CONTINUE, CREDENTIAL_CHARSET, HTTP_ELEMENT_CHARSET, HTTP_URI_CHARSET, HTTP_CONTENT_CHARSET, COOKIE_POLICY, WARN_EXTRA_INPUT, STATUS_LINE_GARBAGE_LIMIT, SO_TIMEOUT, DATE_PATTERNS, RETRY_HANDLER, BUFFER_WARN_TRIGGER_LIMIT, VIRTUAL_HOST, MULTIPART_BOUNDARY

Fields inherited from org.apache.commons.httpclient.params.HttpMethodParams:

USER_AGENT, PROTOCOL_VERSION, UNAMBIGUOUS_STATUS_LINE, SINGLE_COOKIE_HEADER, STRICT_TRANSFER_ENCODING, REJECT_HEAD_BODY, HEAD_BODY_CHECK_TIMEOUT, USE_EXPECT_CONTINUE, CREDENTIAL_CHARSET, HTTP_ELEMENT_CHARSET, HTTP_URI_CHARSET, HTTP_CONTENT_CHARSET, COOKIE_POLICY, WARN_EXTRA_INPUT, STATUS_LINE_GARBAGE_LIMIT, SO_TIMEOUT, DATE_PATTERNS, RETRY_HANDLER, BUFFER_WARN_TRIGGER_LIMIT, VIRTUAL_HOST, MULTIPART_BOUNDARY

Constructor:

Constructor:
public HttpClientParams() { super(); } Creates a new collection of parameters with the collection returned by #getDefaultParams() as a parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself. Also see: getDefaultParams()
public HttpClientParams(HttpParams defaults) { super(defaults); } Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself. Parameters: `defaults` - the parent collection to defer to, if a parameter is not explictly set in the collection itself. Also see: getDefaultParams()

 public HttpClientParams() {
                                                    
        super();
}

Creates a new collection of parameters with the collection returned by

#getDefaultParams()

Also see:

getDefaultParams()

 public HttpClientParams(HttpParams defaults) {
        super(defaults);
}

Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.

Parameters:

defaults - the parent collection to defer to, if a parameter is not explictly set in the collection itself.

Also see:

getDefaultParams()

Method from org.apache.commons.httpclient.params.HttpClientParams Summary:
getConnectionManagerClass, getConnectionManagerTimeout, isAuthenticationPreemptive, makeLenient, makeStrict, setAuthenticationPreemptive, setConnectionManagerClass, setConnectionManagerTimeout

Methods from org.apache.commons.httpclient.params.HttpMethodParams:
getContentCharset, getCookiePolicy, getCredentialCharset, getHttpElementCharset, getSoTimeout, getUriCharset, getVersion, getVirtualHost, makeLenient, makeStrict, setContentCharset, setCookiePolicy, setCredentialCharset, setHttpElementCharset, setSoTimeout, setUriCharset, setVersion, setVirtualHost

Methods from org.apache.commons.httpclient.params.DefaultHttpParams:
clear, clone, getBooleanParameter, getDefaultParams, getDefaults, getDoubleParameter, getIntParameter, getLongParameter, getParameter, isParameterFalse, isParameterSet, isParameterSetLocally, isParameterTrue, setBooleanParameter, setDefaults, setDoubleParameter, setHttpParamsFactory, setIntParameter, setLongParameter, setParameter, setParameters

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.httpclient.params.HttpClientParams Detail:
public Class getConnectionManagerClass() { return (Class) getParameter(CONNECTION_MANAGER_CLASS); } Returns the default HTTP connection manager class.
public long getConnectionManagerTimeout() { return getLongParameter(CONNECTION_MANAGER_TIMEOUT, 0); } Returns the timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager .
public boolean isAuthenticationPreemptive() { return getBooleanParameter(PREEMPTIVE_AUTHENTICATION, false); } Returns `true` if authentication should be attempted preemptively, `false` otherwise.
public void makeLenient() { super.makeLenient(); setParameters(PROTOCOL_STRICTNESS_PARAMETERS, Boolean.FALSE); }
public void makeStrict() { super.makeStrict(); setParameters(PROTOCOL_STRICTNESS_PARAMETERS, Boolean.TRUE); }
public void setAuthenticationPreemptive(boolean value) { setBooleanParameter(PREEMPTIVE_AUTHENTICATION, value); } Sets whether authentication should be attempted preemptively.
public void setConnectionManagerClass(Class clazz) { setParameter(CONNECTION_MANAGER_CLASS, clazz); } Sets HTTP connection manager class to be used der default.
public void setConnectionManagerTimeout(long timeout) { setLongParameter(CONNECTION_MANAGER_TIMEOUT, timeout); } Sets the timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager .

Method from org.apache.commons.httpclient.params.HttpClientParams Detail:

 public Class getConnectionManagerClass() {
        return (Class) getParameter(CONNECTION_MANAGER_CLASS);
}

HTTP connection manager

 public long getConnectionManagerTimeout() {
        return getLongParameter(CONNECTION_MANAGER_TIMEOUT, 0);
}

HTTP connection

HTTP connection manager

 public boolean isAuthenticationPreemptive() {
        return getBooleanParameter(PREEMPTIVE_AUTHENTICATION, false);
}

true

false

 public  void makeLenient() {
        super.makeLenient();
        setParameters(PROTOCOL_STRICTNESS_PARAMETERS, Boolean.FALSE);
}

 public  void makeStrict() {
       
        super.makeStrict();
        setParameters(PROTOCOL_STRICTNESS_PARAMETERS, Boolean.TRUE);
}

 public  void setAuthenticationPreemptive(boolean value) {
        setBooleanParameter(PREEMPTIVE_AUTHENTICATION, value);
}

Sets whether authentication should be attempted preemptively.

 public  void setConnectionManagerClass(Class clazz) {
        setParameter(CONNECTION_MANAGER_CLASS, clazz);
}

HTTP connection manager

 public  void setConnectionManagerTimeout(long timeout) {
        setLongParameter(CONNECTION_MANAGER_TIMEOUT, timeout);
}

HTTP connection

HTTP connection manager