Package org.apache.commons.httpclient

Class HttpState

java.lang.Object
org.apache.commons.httpclient.HttpState
@Deprecated public class HttpState extends Object
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.

A container for HTTP attributes that may persist from request to request, such as cookies and authentication credentials.

  • Field Details

    • PREEMPTIVE_PROPERTY

      public static final String PREEMPTIVE_PROPERTY
      Deprecated.
      This field and feature will be removed following HttpClient 3.0.
      The boolean system property name to turn on preemptive authentication.
      See Also:

    • PREEMPTIVE_DEFAULT

      public static final String PREEMPTIVE_DEFAULT
      Deprecated.
      This field and feature will be removed following HttpClient 3.0.
      The default value for PREEMPTIVE_PROPERTY.
      See Also:

  • Constructor Details

    • HttpState

      public HttpState()
      Deprecated.
      Default constructor.

  • Method Details

    • addCookie

      public void addCookie(Cookie cookie)
      Deprecated.
      Adds an HTTP cookie, replacing any existing equivalent cookies. If the given cookie has already expired it will not be added, but existing values will still be removed.
      Parameters:
      cookie - the cookie to be added
      See Also:

    • addCookies

      public void addCookies(Cookie[] cookies)
      Deprecated.
      Adds an array of HTTP cookies. Cookies are added individually and in the given array order. If any of the given cookies has already expired it will not be added, but existing values will still be removed.
      Parameters:
      cookies - the cookies to be added
      See Also:

    • getCookies

      public Cookie[] getCookies()
      Deprecated.
      Returns an array of cookies that this HTTP state currently contains.
      Returns:
      an array of cookies.
      See Also:

    • getCookies

      public Cookie[] getCookies(String domain, int port, String path, boolean secure)
      Deprecated.
      use CookieSpec#match(String, int, String, boolean, Cookie)
      Returns an array of cookies in this HTTP state that match the given request parameters.
      Parameters:
      domain - the request domain
      port - the request port
      path - the request path
      secure - true when using HTTPS
      Returns:
      an array of cookies.
      See Also:

    • purgeExpiredCookies

      public boolean purgeExpiredCookies()
      Deprecated.
      Removes all of cookies in this HTTP state that have expired according to the current system time.
      See Also:

    • purgeExpiredCookies

      public boolean purgeExpiredCookies(Date date)
      Deprecated.
      Removes all of cookies in this HTTP state that have expired by the specified date.
      Parameters:
      date - The date to compare against.
      Returns:
      true if any cookies were purged.
      See Also:

    • getCookiePolicy

      public int getCookiePolicy()
      Deprecated.
      Use HttpMethodParams.getCookiePolicy(), HttpMethod.getParams().
      Returns the current cookie policy for this HTTP state.
      Returns:
      The cookie policy.

    • setAuthenticationPreemptive

      public void setAuthenticationPreemptive(boolean value)
      Deprecated.
      Use HttpClientParams.setAuthenticationPreemptive(boolean), HttpClient.getParams().
      Defines whether preemptive authentication should be attempted.
      Parameters:
      value - true if preemptive authentication should be attempted, false otherwise.

    • isAuthenticationPreemptive

      public boolean isAuthenticationPreemptive()
      Deprecated.
      Use HttpClientParams.isAuthenticationPreemptive(), HttpClient.getParams().
      Returns true if preemptive authentication should be attempted, false otherwise.
      Returns:
      boolean flag.

    • setCookiePolicy

      public void setCookiePolicy(int policy)
      Deprecated.
      Use HttpMethodParams.setCookiePolicy(String), HttpMethod.getParams().
      Sets the current cookie policy for this HTTP state to one of the following supported policies: CookiePolicy.COMPATIBILITY, CookiePolicy.NETSCAPE_DRAFT or CookiePolicy.RFC2109.
      Parameters:
      policy - new cookie policy

    • setCredentials

      public void setCredentials(String realm, String host, Credentials credentials)
      Deprecated.
      use #setCredentials(AuthScope, Credentials)
      Sets the credentials for the given authentication realm on the given host. The null realm signifies default credentials for the given host, which should be used when no credentials have been explictly supplied for the challenging realm. The null host signifies default credentials, which should be used when no credentials have been explictly supplied for the challenging host. Any previous credentials for the given realm on the given host will be overwritten.
      Parameters:
      realm - the authentication realm
      host - the host the realm belongs to
      credentials - the authentication credentials for the given realm.
      See Also:

    • setCredentials

      public void setCredentials(AuthScope authscope, Credentials credentials)
      Deprecated.
      Sets the credentials for the given authentication scope. Any previous credentials for the given scope will be overwritten.
      Parameters:
      authscope - the authentication scope
      credentials - the authentication credentials for the given scope.
      Since:
      3.0
      See Also:

    • getCredentials

      public Credentials getCredentials(String realm, String host)
      Deprecated.
      use #getCredentials(AuthScope)
      Get the credentials for the given authentication scope on the given host. If the realm exists on host, return the coresponding credentials. If the host exists with a null realm, return the corresponding credentials. If the realm exists with a null host, return the corresponding credentials. If the realm does not exist, return the default Credentials. If there are no default credentials, return null.
      Parameters:
      realm - the authentication realm
      host - the host the realm is on
      Returns:
      the credentials
      See Also:

    • getCredentials

      public Credentials getCredentials(AuthScope authscope)
      Deprecated.
      Get the credentials for the given authentication scope.
      Parameters:
      authscope - the authentication scope
      Returns:
      the credentials
      Since:
      3.0
      See Also:

    • setProxyCredentials

      public void setProxyCredentials(String realm, String proxyHost, Credentials credentials)
      Deprecated.
      use #setProxyCredentials(AuthScope, Credentials)
      Sets the credentials for the given proxy authentication realm on the given proxy host. The null proxy realm signifies default credentials for the given proxy host, which should be used when no credentials have been explictly supplied for the challenging proxy realm. The null proxy host signifies default credentials, which should be used when no credentials have been explictly supplied for the challenging proxy host. Any previous credentials for the given proxy realm on the given proxy host will be overwritten.
      Parameters:
      realm - the authentication realm
      proxyHost - the proxy host
      credentials - the authentication credentials for the given realm
      See Also:

    • setProxyCredentials

      public void setProxyCredentials(AuthScope authscope, Credentials credentials)
      Deprecated.
      Sets the proxy credentials for the given authentication realm. Any previous credentials for the given realm will be overwritten.
      Parameters:
      authscope - the authentication scope
      credentials - the authentication credentials for the given realm.
      Since:
      3.0
      See Also:

    • getProxyCredentials

      public Credentials getProxyCredentials(String realm, String proxyHost)
      Deprecated.
      use #getProxyCredentials(AuthScope)
      Get the credentials for the proxy host with the given authentication scope. If the realm exists on host, return the coresponding credentials. If the host exists with a null realm, return the corresponding credentials. If the realm exists with a null host, return the corresponding credentials. If the realm does not exist, return the default Credentials. If there are no default credentials, return null.
      Parameters:
      realm - the authentication realm
      proxyHost - the proxy host the realm is on
      Returns:
      the credentials
      See Also:

    • getProxyCredentials

      public Credentials getProxyCredentials(AuthScope authscope)
      Deprecated.
      Get the proxy credentials for the given authentication scope.
      Parameters:
      authscope - the authentication scope
      Returns:
      the credentials
      Since:
      3.0
      See Also:

    • toString

      public String toString()
      Deprecated.
      Returns a string representation of this HTTP state.
      Overrides:
      toString in class Object
      Returns:
      The string representation of the HTTP state.
      See Also:

    • clearCredentials

      public void clearCredentials()
      Deprecated.
      Clears all credentials.

    • clearProxyCredentials

      public void clearProxyCredentials()
      Deprecated.
      Clears all proxy credentials.

    • clearCookies

      public void clearCookies()
      Deprecated.
      Clears all cookies.

    • clear

      public void clear()
      Deprecated.
      Clears the state information (all cookies, credentials and proxy credentials).