Class BasicCookieStore

java.lang.Object
org.apache.http.impl.client.BasicCookieStore
All Implemented Interfaces:
CookieStore

public class BasicCookieStore
extends Object
implements CookieStore
Default implementation of CookieStore
Since:
4.0
Author:
Remy Maucherat, Rodney Waldhoff, Jeff Dever, Sean C. Sullivan, Michael Becke, Oleg Kalnichevski, Mike Bowler, Adrian Sutton
  • Constructor Details

    • BasicCookieStore

      public BasicCookieStore()
      Default constructor.
  • Method Details

    • addCookie

      public void addCookie​(Cookie cookie)
      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.
      Specified by:
      addCookie in interface CookieStore
      Parameters:
      cookie - the cookie to be added
      See Also:
      addCookies(Cookie[])
    • addCookies

      public void addCookies​(Cookie[] cookies)
      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:
      addCookie(Cookie)
    • getCookies

      public List<Cookie> getCookies()
      Returns an immutable array of cookies that this HTTP state currently contains.
      Specified by:
      getCookies in interface CookieStore
      Returns:
      an array of cookies.
    • clearExpired

      public boolean clearExpired​(Date date)
      Removes all of cookies in this HTTP state that have expired by the specified date.
      Specified by:
      clearExpired in interface CookieStore
      Returns:
      true if any cookies were purged.
      See Also:
      Cookie.isExpired(Date)
    • toString

      public String toString()
      Description copied from class: Object
      Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
         getClass().getName() + '@' + Integer.toHexString(hashCode())

      See Writing a useful toString method if you intend implementing your own toString method.

      Overrides:
      toString in class Object
      Returns:
      a printable representation of this object.
    • clear

      public void clear()
      Clears all cookies.
      Specified by:
      clear in interface CookieStore