Package ortus.boxlang.web.exchange

Class BoxCookie

java.lang.Object
ortus.boxlang.web.exchange.BoxCookie
public class BoxCookie extends Object

  • Constructor Details

  • Method Details

    • getName

      public String getName()

    • getValue

      public String getValue()

    • getEncodedValue

      public String getEncodedValue()
      Get the encoded cookie value in a format suitable for the HTTP header. If encodeValue is set to false, this will return the value as-is.
      Returns:
      The cookie value, encoded if necessary

    • setValue

      public BoxCookie setValue(String value)
      This always returns the NON-encoded value, even if encodeValue is set to true.
      Parameters:
      value - The cookie value with no encoding. Do NOT use this to set an HTTP SET-COOKIE header.
      Returns:
      The BoxCookie instance for chaining

    • getPath

      public String getPath()

    • setPath

      public BoxCookie setPath(String path)

    • getDomain

      public String getDomain()

    • setDomain

      public BoxCookie setDomain(String domain)

    • getMaxAge

      public Integer getMaxAge()

    • setMaxAge

      public BoxCookie setMaxAge(Integer maxAge)

    • isDiscard

      public boolean isDiscard()

    • setDiscard

      public BoxCookie setDiscard(boolean discard)

    • isSecure

      public boolean isSecure()

    • setSecure

      public BoxCookie setSecure(boolean secure)

    • getVersion

      public int getVersion()

    • setVersion

      public BoxCookie setVersion(int version)

    • isHttpOnly

      public boolean isHttpOnly()

    • setHttpOnly

      public BoxCookie setHttpOnly(boolean httpOnly)

    • getExpires

      public Date getExpires()

    • setExpires

      public BoxCookie setExpires(Date expires)

    • getComment

      public String getComment()

    • setComment

      public BoxCookie setComment(String comment)

    • isSameSite

      public boolean isSameSite()

    • setSameSite

      public BoxCookie setSameSite(boolean sameSite)

    • getSameSiteMode

      public String getSameSiteMode()

    • setSameSiteMode

      public BoxCookie setSameSiteMode(String mode)
      Set the SameSite mode for the cookie. This will automatically set the SameSite flag to true.
      Parameters:
      mode - One of the strings Strict, Lax, or None
      Returns:

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object other)
      Overrides:
      equals in class Object

    • toString

      public final String toString()
      Overrides:
      toString in class Object

    • fromEncoded

      public static BoxCookie fromEncoded(String name, String value)
      Create a new cookie from an incoming cookie header, decoding the value.
      Parameters:
      name - The cookie name
      value - The encoded cookie value
      Returns:
      A new BoxCookie instance with the name and value set

    • toSetCookieHeader

      public String toSetCookieHeader()
      Generate the Set-Cookie header value for this cookie.
      Returns:
      A string representing the Set-Cookie header value.