Package org.apache.commons.httpclient.params

Class DefaultHttpParams

java.lang.Object
org.apache.commons.httpclient.params.DefaultHttpParams
All Implemented Interfaces:
Serializable, Cloneable, HttpParams
Direct Known Subclasses:
HostParams, HttpConnectionParams, HttpMethodParams
@Deprecated public class DefaultHttpParams extends Object implements HttpParams, Serializable, Cloneable
Deprecated.
Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.
This class represents a collection of HTTP protocol parameters. 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.
Since:
3.0
See Also:

  • Constructor Details

    • DefaultHttpParams

      public DefaultHttpParams(HttpParams defaults)
      Deprecated.
      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.

    • DefaultHttpParams

      public DefaultHttpParams()
      Deprecated.
      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.
      See Also:

  • Method Details

    • getDefaultParams

      public static HttpParams getDefaultParams()
      Deprecated.
      Gets the default HttpParams to be used.
      Returns:
      the value returned from HttpParamsFactory#getDefaultParams()
      See Also:

    • setHttpParamsFactory

      public static void setHttpParamsFactory(HttpParamsFactory httpParamsFactory)
      Deprecated.
      Sets the factory that will provide the default HttpParams.
      Parameters:
      httpParamsFactory - an instance of HttpParamsFactory
      See Also:

    • getDefaults

      public HttpParams getDefaults()
      Deprecated.
      Description copied from interface: HttpParams
      Returns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself
      Specified by:
      getDefaults in interface HttpParams
      Returns:
      the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
      See Also:

    • setDefaults

      public void setDefaults(HttpParams params)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself
      Specified by:
      setDefaults in interface HttpParams
      Parameters:
      params - the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
      See Also:

    • getParameter

      public Object getParameter(String name)
      Deprecated.
      Description copied from interface: HttpParams
      Returns a parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, null value is returned.
      Specified by:
      getParameter in interface HttpParams
      Parameters:
      name - the parent name.
      Returns:
      an object that represents the value of the parameter.
      See Also:

    • setParameter

      public void setParameter(String name, Object value)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns the value to the parameter with the given name
      Specified by:
      setParameter in interface HttpParams
      Parameters:
      name - parameter name
      value - parameter value

    • setParameters

      public void setParameters(String[] names, Object value)
      Deprecated.
      Assigns the value to all the parameter with the given names
      Parameters:
      names - array of parameter name
      value - parameter value

    • getLongParameter

      public long getLongParameter(String name, long defaultValue)
      Deprecated.
      Description copied from interface: HttpParams
      Returns a Long parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.
      Specified by:
      getLongParameter in interface HttpParams
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Long that represents the value of the parameter.
      See Also:

    • setLongParameter

      public void setLongParameter(String name, long value)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns a Long to the parameter with the given name
      Specified by:
      setLongParameter in interface HttpParams
      Parameters:
      name - parameter name
      value - parameter value

    • getIntParameter

      public int getIntParameter(String name, int defaultValue)
      Deprecated.
      Description copied from interface: HttpParams
      Returns an Integer parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.
      Specified by:
      getIntParameter in interface HttpParams
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Integer that represents the value of the parameter.
      See Also:

    • setIntParameter

      public void setIntParameter(String name, int value)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns an Integer to the parameter with the given name
      Specified by:
      setIntParameter in interface HttpParams
      Parameters:
      name - parameter name
      value - parameter value

    • getDoubleParameter

      public double getDoubleParameter(String name, double defaultValue)
      Deprecated.
      Description copied from interface: HttpParams
      Returns a Double parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.
      Specified by:
      getDoubleParameter in interface HttpParams
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Double that represents the value of the parameter.
      See Also:

    • setDoubleParameter

      public void setDoubleParameter(String name, double value)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns a Double to the parameter with the given name
      Specified by:
      setDoubleParameter in interface HttpParams
      Parameters:
      name - parameter name
      value - parameter value

    • getBooleanParameter

      public boolean getBooleanParameter(String name, boolean defaultValue)
      Deprecated.
      Description copied from interface: HttpParams
      Returns a Boolean parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.
      Specified by:
      getBooleanParameter in interface HttpParams
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Boolean that represents the value of the parameter.
      See Also:

    • setBooleanParameter

      public void setBooleanParameter(String name, boolean value)
      Deprecated.
      Description copied from interface: HttpParams
      Assigns a Boolean to the parameter with the given name
      Specified by:
      setBooleanParameter in interface HttpParams
      Parameters:
      name - parameter name
      value - parameter value

    • isParameterSet

      public boolean isParameterSet(String name)
      Deprecated.
      Description copied from interface: HttpParams
      Returns true if the parameter is set at any level, false otherwise.
      Specified by:
      isParameterSet in interface HttpParams
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is set at any level, false otherwise.

    • isParameterSetLocally

      public boolean isParameterSetLocally(String name)
      Deprecated.
      Description copied from interface: HttpParams
      Returns true if the parameter is set locally, false otherwise.
      Specified by:
      isParameterSetLocally in interface HttpParams
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is set locally, false otherwise.

    • isParameterTrue

      public boolean isParameterTrue(String name)
      Deprecated.
      Description copied from interface: HttpParams
      Returns true if the parameter is set and is true, false otherwise.
      Specified by:
      isParameterTrue in interface HttpParams
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is set and is true, false otherwise.

    • isParameterFalse

      public boolean isParameterFalse(String name)
      Deprecated.
      Description copied from interface: HttpParams
      Returns true if the parameter is either not set or is false, false otherwise.
      Specified by:
      isParameterFalse in interface HttpParams
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is either not set or is false, false otherwise.

    • clear

      public void clear()
      Deprecated.
      Removes all parameters from this collection.

    • clone

      public Object clone() throws CloneNotSupportedException
      Deprecated.
      Clones this collection of parameters. Please note that paramter values themselves are not cloned.
      Throws:
      CloneNotSupportedException
      See Also: