Package org.apache.commons.httpclient.params

Class HttpClientParams

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, HttpParams
    @Deprecated
public class HttpClientParams
extends HttpMethodParams
    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 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.
    Since:
    3.0
    See Also:
    Serialized Form

    • Field Detail

      • CONNECTION_MANAGER_CLASS

        public static final java.lang.String CONNECTION_MANAGER_CLASS
        Deprecated.
        Defines the default HTTP connection manager class.

        This parameter expects a value of type Class.

        See Also:
        Constant Field Values

      • PREEMPTIVE_AUTHENTICATION

        public static final java.lang.String PREEMPTIVE_AUTHENTICATION
        Deprecated.
        Defines whether authentication should be attempted preemptively.

        This parameter expects a value of type Boolean.

        See Also:
        Constant Field Values

      • REJECT_RELATIVE_REDIRECT

        public static final java.lang.String REJECT_RELATIVE_REDIRECT
        Deprecated.
        Defines whether relative redirects should be rejected.

        This parameter expects a value of type Boolean.

        See Also:
        Constant Field Values

      • MAX_REDIRECTS

        public static final java.lang.String MAX_REDIRECTS
        Deprecated.
        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.

        See Also:
        Constant Field Values

      • ALLOW_CIRCULAR_REDIRECTS

        public static final java.lang.String ALLOW_CIRCULAR_REDIRECTS
        Deprecated.
        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.

        See Also:
        Constant Field Values

    • Constructor Detail

      • HttpClientParams

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

    • Method Detail

      • getConnectionManagerTimeout

        public long getConnectionManagerTimeout()
        Deprecated.
        Returns the timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager.
        Returns:
        timeout in milliseconds.

      • setConnectionManagerTimeout

        public void setConnectionManagerTimeout​(long timeout)
        Deprecated.
        Sets the timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager.
        Parameters:
        timeout - the timeout in milliseconds

      • isAuthenticationPreemptive

        public boolean isAuthenticationPreemptive()
        Deprecated.
        Returns true if authentication should be attempted preemptively, false otherwise.
        Returns:
        true if authentication should be attempted preemptively, false otherwise.

      • setAuthenticationPreemptive

        public void setAuthenticationPreemptive​(boolean value)
        Deprecated.
        Sets whether authentication should be attempted preemptively.
        Parameters:
        value - true if authentication should be attempted preemptively, false otherwise.

      • makeStrict

        public void makeStrict()
        Deprecated.
        Description copied from class: HttpMethodParams
        Makes the HTTP methods strictly follow the HTTP protocol specification (RFC 2616 and other relevant RFCs). It must be noted that popular HTTP agents have different degree of HTTP protocol compliance and some HTTP serves are programmed to expect the behaviour that does not strictly adhere to the HTTP specification.
        Overrides:
        makeStrict in class HttpMethodParams

      • makeLenient

        public void makeLenient()
        Deprecated.
        Description copied from class: HttpMethodParams
        Makes the HTTP methods attempt to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect, even though such behaviour may violate the HTTP protocol specification (RFC 2616 and other relevant RFCs).
        Overrides:
        makeLenient in class HttpMethodParams