Package play.core.cookie.encoding

Interface Cookie

    • Method Detail

      • value

        String value()
        Returns the value of this Cookie.
        Returns:
        The value of this Cookie

      • setValue

        void setValue​(String value)
        Sets the value of this Cookie.
        Parameters:
        value - The value to set

      • wrap

        boolean wrap()
        Returns true if the raw value of this Cookie, was wrapped with double quotes in original Set-Cookie header.
        Returns:
        If the value of this Cookie is to be wrapped

      • setWrap

        void setWrap​(boolean wrap)
        Sets true if the value of this Cookie is to be wrapped with double quotes.
        Parameters:
        wrap - true if wrap

      • domain

        String domain()
        Returns the domain of this Cookie.
        Returns:
        The domain of this Cookie

      • setDomain

        void setDomain​(String domain)
        Sets the domain of this Cookie.
        Parameters:
        domain - The domain to use

      • setPath

        void setPath​(String path)
        Sets the path of this Cookie.
        Parameters:
        path - The path to use for this Cookie

      • maxAge

        int maxAge()
        Returns the maximum age of this Cookie in seconds or Integer.MIN_VALUE if unspecified
        Returns:
        The maximum age of this Cookie

      • sameSite

        String sameSite()
        Returns the SameSite attribute of this cookie as a String
        Returns:
        The SameSite attribute of the cookie

      • setMaxAge

        void setMaxAge​(int maxAge)
        Sets the maximum age of this Cookie in seconds. If an age of 0 is specified, this Cookie will be automatically removed by browser because it will expire immediately. If Integer.MIN_VALUE is specified, this Cookie will be removed when the browser is closed.
        Parameters:
        maxAge - The maximum age of this Cookie in seconds

      • isSecure

        boolean isSecure()
        Checks to see if this Cookie is secure
        Returns:
        True if this Cookie is secure, otherwise false

      • setSecure

        void setSecure​(boolean secure)
        Sets the security getStatus of this Cookie
        Parameters:
        secure - True if this Cookie is to be secure, otherwise false

      • isHttpOnly

        boolean isHttpOnly()
        Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it. For more information, please look here
        Returns:
        True if this Cookie is HTTP-only or false if it isn't

      • setHttpOnly

        void setHttpOnly​(boolean httpOnly)
        Determines if this Cookie is HTTP only. If set to true, this Cookie cannot be accessed by a client side script. However, this works only if the browser supports it. For for information, please look here.
        Parameters:
        httpOnly - True if the Cookie is HTTP only, otherwise false.