Package org.apache.commons.httpclient.cookie

Interface CookieAttributeHandler

@Deprecated public interface CookieAttributeHandler
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.
Ths interface represents a cookie attribute handler responsible for parsing, validating, and matching a specific cookie attribute, such as path, domain, port, etc. Different cookie specifications can provide a specific implementation for this class based on their cookie handling rules.
Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    match(Cookie cookie, CookieOrigin origin)
    Deprecated.
    Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute.
    void
    parse(Cookie cookie, String value)
    Deprecated.
    Parse the given cookie attribute value and update the corresponding Cookie property.
    void
    validate(Cookie cookie, CookieOrigin origin)
    Deprecated.
    Peforms cookie validation for the given attribute value.

  • Method Details

    • parse

      void parse(Cookie cookie, String value) throws MalformedCookieException
      Deprecated.
      Parse the given cookie attribute value and update the corresponding Cookie property.
      Parameters:
      cookie - Cookie to be updated
      value - cookie attribute value from the cookie response header
      Throws:
      MalformedCookieException

    • validate

      void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException
      Deprecated.
      Peforms cookie validation for the given attribute value.
      Parameters:
      cookie - Cookie to validate
      origin - the cookie source to validate against
      Throws:
      MalformedCookieException - if cookie validation fails for this attribute

    • match

      boolean match(Cookie cookie, CookieOrigin origin)
      Deprecated.
      Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute.
      Parameters:
      cookie - Cookie to match
      origin - the cookie source to match against
      Returns:
      true if the match is successful; false otherwise