Class Network.CookieParam

    • Field Summary

       
      Serializable ID
      Modifier and Type Field
      protected static long serialVersionUID
      For Object Serialization.
       
      Type Properties
      Modifier and Type Field
      String domain
      Cookie domain.
      Number expires
      Cookie expiration date, session cookie if not set

      OPTIONAL
      Boolean httpOnly
      True if cookie is http-only.
      String name
      Cookie name.
      String path
      Cookie path.
      String priority
      Cookie Priority.
      Boolean sameParty
      True if cookie is SameParty.
      String sameSite
      Cookie SameSite type.
      Boolean secure
      True if cookie is secure.
      Integer sourcePort
      Cookie source port.
      String sourceScheme
      Cookie source scheme type.
      String url
      The request-URI to associate with the setting of the cookie.
      String value
      Cookie value.
    • Constructor Summary

      Constructors 
      Constructor Description
      CookieParam​(String name, String value, String url, String domain, String path, Boolean secure, Boolean httpOnly, String sameSite, Number expires, String priority, Boolean sameParty, String sourceScheme, Integer sourcePort)
      Constructor
      CookieParam​(JsonObject jo)
      JSON Object Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object other)
      Checks whether 'this' equals an input Java-Object
      int hashCode()
      Generates a Hash-Code for 'this' instance
      boolean[] optionals()
      Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CookieParam

        🡅  🡇     🗕  🗗  🗖
        public CookieParam​(java.lang.String name,
                           java.lang.String value,
                           java.lang.String url,
                           java.lang.String domain,
                           java.lang.String path,
                           java.lang.Boolean secure,
                           java.lang.Boolean httpOnly,
                           java.lang.String sameSite,
                           java.lang.Number expires,
                           java.lang.String priority,
                           java.lang.Boolean sameParty,
                           java.lang.String sourceScheme,
                           java.lang.Integer sourcePort)
        Constructor
        Parameters:
        name - Cookie name.
        value - Cookie value.
        url - 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.
        OPTIONAL
        domain - Cookie domain.
        OPTIONAL
        path - Cookie path.
        OPTIONAL
        secure - True if cookie is secure.
        OPTIONAL
        httpOnly - True if cookie is http-only.
        OPTIONAL
        sameSite - Cookie SameSite type.
        OPTIONAL
        expires - Cookie expiration date, session cookie if not set
        OPTIONAL
        priority - Cookie Priority.
        OPTIONAL
        EXPERIMENTAL
        sameParty - True if cookie is SameParty.
        OPTIONAL
        EXPERIMENTAL
        sourceScheme - Cookie source scheme type.
        OPTIONAL
        EXPERIMENTAL
        sourcePort - 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.
        OPTIONAL
        EXPERIMENTAL
    • Method Detail

      • optionals

        🡅  🡇     🗕  🗗  🗖
        public boolean[] optionals()
        Description copied from class: BaseType
        Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

        NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...
        Specified by:
        optionals in class BaseType
        Returns:
        A boolean[] array whose length is precisely equal to the number of fields in the Java Object.
      • equals

        🡅  🡇     🗕  🗗  🗖
        public boolean equals​(java.lang.Object other)
        Checks whether 'this' equals an input Java-Object
        Overrides:
        equals in class java.lang.Object
      • hashCode

        🡅     🗕  🗗  🗖
        public int hashCode()
        Generates a Hash-Code for 'this' instance
        Overrides:
        hashCode in class java.lang.Object