Interface Cookie

  • All Known Implementing Classes:
    SimpleCookie

    public interface Cookie
    Interface representing HTTP cookie operations, supporting pojo-style getters and setters for all attributes which includes HttpOnly support. This allows Shiro to set HttpOnly cookies even on Servlet containers based on the 2.4 and 2.5 API (Servlet API 'native' support was only introduced in the 2.6 specification).
    Since:
    1.0
    • Field Detail

      • DELETED_COOKIE_VALUE

        static final String DELETED_COOKIE_VALUE
        The value of deleted cookie (with the maxAge 0).
        See Also:
        Constant Field Values
      • ONE_YEAR

        static final int ONE_YEAR
        The number of seconds in one year (= 60 * 60 * 24 * 365).
        See Also:
        Constant Field Values
      • ROOT_PATH

        static final String ROOT_PATH
        Root path to use when the path hasn't been set and request context root is empty or null.
        See Also:
        Constant Field Values
    • Method Detail

      • setName

        void setName​(String name)
      • setValue

        void setValue​(String value)
      • getComment

        String getComment()
      • setComment

        void setComment​(String comment)
      • getDomain

        String getDomain()
      • setDomain

        void setDomain​(String domain)
      • getMaxAge

        int getMaxAge()
      • setMaxAge

        void setMaxAge​(int maxAge)
      • setPath

        void setPath​(String path)
      • isSecure

        boolean isSecure()
      • setSecure

        void setSecure​(boolean secure)
      • getVersion

        int getVersion()
      • setVersion

        void setVersion​(int version)
      • setHttpOnly

        void setHttpOnly​(boolean httpOnly)
      • isHttpOnly

        boolean isHttpOnly()
      • saveTo

        void saveTo​(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
      • removeFrom

        void removeFrom​(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
      • readValue

        String readValue​(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)