Class CookieParam


  • public class CookieParam
    extends java.lang.Object
    Cookie parameter object
    • Constructor Summary

      Constructors 
      Constructor Description
      CookieParam​(java.lang.String name, java.lang.String value, java.util.Optional<java.lang.String> url, java.util.Optional<java.lang.String> domain, java.util.Optional<java.lang.String> path, java.util.Optional<java.lang.Boolean> secure, java.util.Optional<java.lang.Boolean> httpOnly, java.util.Optional<CookieSameSite> sameSite, java.util.Optional<TimeSinceEpoch> expires, java.util.Optional<CookiePriority> priority, java.util.Optional<java.lang.Boolean> sameParty, java.util.Optional<CookieSourceScheme> sourceScheme, java.util.Optional<java.lang.Integer> sourcePort, java.util.Optional<java.lang.String> partitionKey)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> getDomain()
      Cookie domain.
      java.util.Optional<TimeSinceEpoch> getExpires()
      Cookie expiration date, session cookie if not set
      java.util.Optional<java.lang.Boolean> getHttpOnly()
      True if cookie is http-only.
      java.lang.String getName()
      Cookie name.
      java.util.Optional<java.lang.String> getPartitionKey()
      Cookie partition key.
      java.util.Optional<java.lang.String> getPath()
      Cookie path.
      java.util.Optional<CookiePriority> getPriority()
      Cookie Priority.
      java.util.Optional<java.lang.Boolean> getSameParty()
      True if cookie is SameParty.
      java.util.Optional<CookieSameSite> getSameSite()
      Cookie SameSite type.
      java.util.Optional<java.lang.Boolean> getSecure()
      True if cookie is secure.
      java.util.Optional<java.lang.Integer> getSourcePort()
      Cookie source port.
      java.util.Optional<CookieSourceScheme> getSourceScheme()
      Cookie source scheme type.
      java.util.Optional<java.lang.String> getUrl()
      The request-URI to associate with the setting of the cookie.
      java.lang.String getValue()
      Cookie value.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CookieParam

        public CookieParam​(java.lang.String name,
                           java.lang.String value,
                           java.util.Optional<java.lang.String> url,
                           java.util.Optional<java.lang.String> domain,
                           java.util.Optional<java.lang.String> path,
                           java.util.Optional<java.lang.Boolean> secure,
                           java.util.Optional<java.lang.Boolean> httpOnly,
                           java.util.Optional<CookieSameSite> sameSite,
                           java.util.Optional<TimeSinceEpoch> expires,
                           java.util.Optional<CookiePriority> priority,
                           java.util.Optional<java.lang.Boolean> sameParty,
                           java.util.Optional<CookieSourceScheme> sourceScheme,
                           java.util.Optional<java.lang.Integer> sourcePort,
                           java.util.Optional<java.lang.String> partitionKey)
    • Method Detail

      • getName

        public java.lang.String getName()
        Cookie name.
      • getValue

        public java.lang.String getValue()
        Cookie value.
      • getUrl

        public java.util.Optional<java.lang.String> getUrl()
        The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
      • getDomain

        public java.util.Optional<java.lang.String> getDomain()
        Cookie domain.
      • getPath

        public java.util.Optional<java.lang.String> getPath()
        Cookie path.
      • getSecure

        public java.util.Optional<java.lang.Boolean> getSecure()
        True if cookie is secure.
      • getHttpOnly

        public java.util.Optional<java.lang.Boolean> getHttpOnly()
        True if cookie is http-only.
      • getSameSite

        public java.util.Optional<CookieSameSite> getSameSite()
        Cookie SameSite type.
      • getExpires

        public java.util.Optional<TimeSinceEpoch> getExpires()
        Cookie expiration date, session cookie if not set
      • getPriority

        @Beta
        public java.util.Optional<CookiePriority> getPriority()
        Cookie Priority.
      • getSameParty

        @Beta
        public java.util.Optional<java.lang.Boolean> getSameParty()
        True if cookie is SameParty.
      • getSourceScheme

        @Beta
        public java.util.Optional<CookieSourceScheme> getSourceScheme()
        Cookie source scheme type.
      • getSourcePort

        @Beta
        public java.util.Optional<java.lang.Integer> getSourcePort()
        Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.
      • getPartitionKey

        @Beta
        public java.util.Optional<java.lang.String> getPartitionKey()
        Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. If not set, the cookie will be set as not partitioned.