HttpSetCookie

All Superinterfaces:: HttpCookiePair

All Known Implementing Classes:: DefaultHttpSetCookie

public interface HttpSetCookie extends HttpCookiePair

An interface defining a set-cookie-string.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

HttpSetCookie.SameSite

Represents samesite-value for the SameSite attribute.
Method Summary

Modifier and Type

Method

Description

CharSequence

domain()

Returns the domain of this HttpSetCookie.

CharSequence

expires()

Returns the expire date of this HttpSetCookie according to Expires.

boolean

isHttpOnly()

Checks to see if this HttpSetCookie can only be accessed via HTTP.

boolean

isSecure()

Checks to see if this HttpSetCookie is secure.

Long

maxAge()

Returns the maximum age of this HttpSetCookie in seconds if specified.

CharSequence

path()

Returns the path of this HttpSetCookie.

HttpSetCookie.SameSite

sameSite()

Get the value for the SameSite attribute.

Methods inherited from interface io.servicetalk.http.api.HttpCookiePair
encoded, isWrapped, name, value

Method Details
- domain
  
  @Nullable CharSequence domain()
  
  Returns the domain of this HttpSetCookie.
  
  Returns:
  
  The domain of this HttpSetCookie
- path
  
  @Nullable CharSequence path()
  
  Returns the path of this HttpSetCookie.
  
  Returns:
  
  The HttpSetCookie's path
- maxAge
  
  @Nullable Long maxAge()
  
  Returns the maximum age of this HttpSetCookie in seconds if specified.
  
  Returns:
  
  The maximum age of this HttpSetCookie. null if none specified.
- expires
  
  @Nullable CharSequence expires()
  
  Returns the expire date of this HttpSetCookie according to Expires.
  
  Returns:
  
  the expire date of this HttpSetCookie according to Expires.
- sameSite
  
  @Nullable HttpSetCookie.SameSite sameSite()
  
  Get the value for the SameSite attribute.
  
  Returns:
  
  The value for the SameSite attribute.
- isSecure
  
  boolean isSecure()
  
  Checks to see if this HttpSetCookie is secure.
  
  Returns:
  
  True if this HttpSetCookie is secure, otherwise false
- isHttpOnly
  
  boolean isHttpOnly()
  
  Checks to see if this HttpSetCookie can only be accessed via HTTP. If this returns true, the HttpSetCookie cannot be accessed through client side script - But only if the browser supports it. For more information, please look here
  
  Returns:
  
  True if this HttpSetCookie is HTTP-only or false if it isn't