Interface CookieHandler


public interface CookieHandler
A cookie handler that allows Platform consumers to add, retrieve, and expire cookies.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCookie(String cookieName, String cookieValue)
    Adds a cookie that will be sent back in the response.
    getCookieValue(String cookieName)
    Accesses the cookie value.
    removeCookie(String cookieName)
    Expires a cookie notifying the user-agent or producer to remove it from their cookie-store.
  • Method Details

    • addCookie

      void addCookie(String cookieName, String cookieValue)
      Adds a cookie that will be sent back in the response.
      Parameters:
      cookieName - the cookie name
      cookieValue - the cookie value
    • removeCookie

      String removeCookie(String cookieName)
      Expires a cookie notifying the user-agent or producer to remove it from their cookie-store.
      Parameters:
      cookieName - the cookie name
      Returns:
      the value of the cookie to expire if one exists, otherwise null
    • getCookieValue

      String getCookieValue(String cookieName)
      Accesses the cookie value.
      Parameters:
      cookieName - the cookie name
      Returns:
      the value of the cookie if one exists, otherwise null