Package com.microstrategy.web.platform

Interface GenericCookie

  • All Known Implementing Classes:
    AbstractConfigurableContainerServices.CookieWrapper
    public interface GenericCookie
    This class represents the features and functionality exposed by a generic Cookie object--independent of the contained web container (e.g., either Java or ASP).
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    ContainerServices

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getMaxAge()
      Returns the maximum age of the current cookie.
      java.lang.String getName()
      Returns the name of the cookie.
      java.lang.String getNativeName()
      Returns the native cookie name.
      java.lang.String getNativeValue()
      Returns the native cookie value.
      java.lang.String getPath()
      Returns the path associated with the current cookie.
      java.lang.String getValue()
      Returns the value of the cookie.
      boolean isHttpOnly()
      Set the http only flag
      boolean isSecure()
      Indicates if the client is only to return the cookie in subsequent requests if those requests use Secure Hypertext Transfer Protocol (HTTPS); The default is false.
      void setHttpOnly​(boolean value)
      get the http only flag
      void setMaxAge​(int maxAge)
      Set the maximum age for a cookie.
      void setPath​(java.lang.String path)
      This method modifies the path associated with the cookie.
      void setSecure​(boolean value)
      Sets the security level of a cookie
      void setValue​(java.lang.String value)
      This method modifies the value of the cookie in current namespace.

    • Method Detail

      • setMaxAge

        void setMaxAge​(int maxAge)
        Set the maximum age for a cookie.
        Parameters:
        maxAge - The age in terms of a number of seconds.

      • getName

        java.lang.String getName()
        Returns the name of the cookie.
        Returns:
        A String which is the name of the cookie. In non-namespace mode, this name is the same as the native cookie name using in browser. In namespace mode, the name is the native name without MicroStrategy prefix. The namespace mode can be configured in ContainerServices.properties.
        See Also:
        ContainerServices

      • getValue

        java.lang.String getValue()
        Returns the value of the cookie.
        Returns:
        A String which is the value of the cookie. In non-namespace mode, this value is the same as the native cookie value stored in browser. In namespace mode, the value contains only the cookie value in current namespace. The namespace mode can be configured in ContainerServices.properties.
        See Also:
        ContainerServices

      • getNativeName

        java.lang.String getNativeName()
        Returns the native cookie name.
        Returns:
        The native cookie name. The native name is the cookie name that is used in Application Server's environment. If the cookie contains namespace information, the cookie name has a special MicroStrategy's prefix.
        Since:
        MicroStrategy Web 8.0.2

      • getNativeValue

        java.lang.String getNativeValue()
        Returns the native cookie value.
        Returns:
        The native cookie value. The native name is the cookie value that is used in Application Server's environment. If the cookie contains namespace information, the cookie value containers all the cookie value of all namespaces.
        Since:
        MicroStrategy Web 8.0.2

      • setValue

        void setValue​(java.lang.String value)
        This method modifies the value of the cookie in current namespace.
        Parameters:
        value - The String value to assign to the cookie.

      • setPath

        void setPath​(java.lang.String path)
        This method modifies the path associated with the cookie.
        Parameters:
        path - The String for the path.

      • getPath

        java.lang.String getPath()
        Returns the path associated with the current cookie.
        Returns:
        the path associated with the current cookie.

      • getMaxAge

        int getMaxAge()
        Returns the maximum age of the current cookie.
        Returns:
        the maximum age of the current cookie.

      • setSecure

        void setSecure​(boolean value)
        Sets the security level of a cookie
        Parameters:
        value - true if the client is to return the cookie only if the request is using HTTPS.
        Since:
        MicroStrategy Web 9.0.0

      • isSecure

        boolean isSecure()
        Indicates if the client is only to return the cookie in subsequent requests if those requests use Secure Hypertext Transfer Protocol (HTTPS); The default is false.
        Returns:
        true is the cookie is secure
        Since:
        MicroStrategy Web 9.0.0

      • setHttpOnly

        void setHttpOnly​(boolean value)
        get the http only flag
        Parameters:
        true - means this cookie is http only
        Since:
        polaris

      • isHttpOnly

        boolean isHttpOnly()
        Set the http only flag
        Returns:
        true means this cookie is http only
        Since:
        polaris