Package org.apache.commons.httpclient.cookie

Class CookiePolicy

  • @Deprecated
public abstract class CookiePolicy
extends java.lang.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.
    Cookie management policy class. The cookie policy provides corresponding cookie management interfrace for a given type or version of cookie.

    RFC 2109 specification is used per default. Other supported specification can be chosen when appropriate or set default when desired

    The following specifications are provided:

    • BROWSER_COMPATIBILITY: compatible with the common cookie management practices (even if they are not 100% standards compliant)
    • NETSCAPE: Netscape cookie draft compliant
    • RFC_2109: RFC2109 compliant (default)
    • IGNORE_COOKIES: do not automcatically process cookies
    Since:
    2.0

    • Field Detail

      • BROWSER_COMPATIBILITY

        public static final java.lang.String BROWSER_COMPATIBILITY
        Deprecated.
        The policy that provides high degree of compatibilty with common cookie management of popular HTTP agents.
        Since:
        3.0
        See Also:
        Constant Field Values

      • NETSCAPE

        public static final java.lang.String NETSCAPE
        Deprecated.
        The Netscape cookie draft compliant policy.
        Since:
        3.0
        See Also:
        Constant Field Values

      • RFC_2109

        public static final java.lang.String RFC_2109
        Deprecated.
        The RFC 2109 compliant policy.
        Since:
        3.0
        See Also:
        Constant Field Values

      • RFC_2965

        public static final java.lang.String RFC_2965
        Deprecated.
        The RFC 2965 compliant policy.
        Since:
        3.0
        See Also:
        Constant Field Values

      • IGNORE_COOKIES

        public static final java.lang.String IGNORE_COOKIES
        Deprecated.
        The policy that ignores cookies.
        Since:
        3.0
        See Also:
        Constant Field Values

      • DEFAULT

        public static final java.lang.String DEFAULT
        Deprecated.
        The default cookie policy.
        Since:
        3.0
        See Also:
        Constant Field Values

      • COMPATIBILITY

        public static final int COMPATIBILITY
        Deprecated.
        Use BROWSER_COMPATIBILITY
        The COMPATIBILITY policy provides high compatibilty with common cookie management of popular HTTP agents.
        See Also:
        Constant Field Values

      • NETSCAPE_DRAFT

        public static final int NETSCAPE_DRAFT
        Deprecated.
        Use NETSCAPE
        The NETSCAPE_DRAFT Netscape draft compliant policy.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CookiePolicy

        public CookiePolicy()
        Deprecated.

    • Method Detail

      • unregisterCookieSpec

        public static void unregisterCookieSpec​(java.lang.String id)
        Deprecated.
        Unregisters the cookie specification with the given ID.
        Parameters:
        id - the ID of the cookie specification to unregister
        Since:
        3.0

      • getSpecByPolicy

        public static CookieSpec getSpecByPolicy​(int policy)
        Deprecated.
        Use getCookieSpec(String)
        Parameters:
        policy - cookie policy to get the CookieSpec for
        Returns:
        cookie specification interface for the given policy

      • getSpecByVersion

        public static CookieSpec getSpecByVersion​(int ver)
        Deprecated.
        Use getCookieSpec(String)
        Gets the CookieSpec for a particular cookie version.

        Supported versions:

        • version 0 corresponds to the Netscape draft
        • version 1 corresponds to the RFC 2109
        • Any other cookie value coresponds to the default spec
          Parameters:
          ver - the cookie version to get the spec for
          Returns:
          cookie specification interface intended for processing cookies with the given version

        • getCompatibilitySpec

          public static CookieSpec getCompatibilitySpec()
          Deprecated.
          Use getCookieSpec(String)
          Returns:
          cookie specification interface that provides high compatibilty with common cookie management of popular HTTP agents

        • getRegisteredCookieSpecs

          public static java.lang.String[] getRegisteredCookieSpecs()
          Deprecated.
          Obtains the currently registered cookie policy names. Note that the DEFAULT policy (if present) is likely to be the same as one of the other policies, but does not have to be.
          Returns:
          array of registered cookie policy names
          Since:
          3.1