Class Cookie

java.lang.Object
com.codename1.io.Cookie
All Implemented Interfaces:
Externalizable
public class Cookie extends Object implements Externalizable
A cookie for an HTTP request

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    STORAGE_NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Cookie()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    clearCookiesFromStorage()
    Clears all cookies history from storage
    void
    externalize(DataOutputStream out)
    Allows us to store an object state, this method must be implemented in order to save the state of an object
    String
    getDomain()
    Returns
    long
    getExpires()
    Returns
    String
    getName()
    Returns
    String
    getObjectId()
    The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
    String
    getPath()
     
    String
    getValue()
    Returns
    int
    getVersion()
    Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
    void
    internalize(int version, DataInputStream in)
    Loads the object from the input stream and allows deserialization
    static boolean
    isAutoStored()
    Returns true if the Cookies are auto stored to storage
    boolean
    isHttpOnly()
     
    boolean
    isSecure()
     
    static void
    setAutoStored(boolean autoStored)
    This method configures the auto storage of cookies
    void
    setDomain(String domain)
    Parameters
    void
    setExpires(long expires)
    Parameters
    void
    setHttpOnly(boolean httpOnly)
     
    void
    setName(String name)
    Parameters
    void
    setPath(String path)
     
    void
    setSecure(boolean secure)
     
    void
    setValue(String value)
    Parameters
    String
    toString()
    Returns a string representation of the object.

    Methods inherited from class Object

    clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
     
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    final Class
    getClass()
    Returns the runtime class of an object.
    int
    hashCode()
    Returns a hash code value for the object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    final void
    wait()
    Causes current thread to wait until another thread invokes the method or the method for this object.
    final void
    wait(long timeout)
    Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
    final void
    wait(long timeout, int nanos)
    Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

  • Field Details

  • Constructor Details

    • Cookie

      public Cookie()

  • Method Details

    • isAutoStored

      public static boolean isAutoStored()

      Returns true if the Cookies are auto stored to storage

      Returns

      autoStored

    • setAutoStored

      public static void setAutoStored(boolean autoStored)

      This method configures the auto storage of cookies

      Parameters
      • autoStored

    • clearCookiesFromStorage

      public static void clearCookiesFromStorage()
      Clears all cookies history from storage

    • getName

      public String getName()
      Returns

      the name

    • setName

      public void setName(String name)
      Parameters
      • name: the name to set

    • isSecure

      public boolean isSecure()

    • setSecure

      public void setSecure(boolean secure)

    • isHttpOnly

      public boolean isHttpOnly()

    • setHttpOnly

      public void setHttpOnly(boolean httpOnly)

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)

    • getValue

      public String getValue()
      Returns

      the value

    • setValue

      public void setValue(String value)
      Parameters
      • value: the value to set

    • getDomain

      public String getDomain()
      Returns

      the domain

    • setDomain

      public void setDomain(String domain)
      Parameters
      • domain: the domain to set

    • getExpires

      public long getExpires()
      Returns

      the expires

    • setExpires

      public void setExpires(long expires)
      Parameters
      • expires: the expires to set

    • getVersion

      public int getVersion()

      Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions

      Returns

      version number for the persistant code

      Specified by:
      getVersion in interface Externalizable

    • externalize

      public void externalize(DataOutputStream out) throws IOException

      Allows us to store an object state, this method must be implemented in order to save the state of an object

      Parameters
      • out: the stream into which the object must be serialized
      Throws
      • java.io.IOException: the method may throw an exception
      Specified by:
      externalize in interface Externalizable
      Throws:
      IOException

    • internalize

      public void internalize(int version, DataInputStream in) throws IOException

      Loads the object from the input stream and allows deserialization

      Parameters

      • version: the version the class returned during the externalization processs

      • in: the input stream used to load the class

      Throws
      • java.io.IOException: the method may throw an exception
      Specified by:
      internalize in interface Externalizable
      Throws:
      IOException

    • getObjectId

      public String getObjectId()

      The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.

      Returns

      a unique id

      Specified by:
      getObjectId in interface Externalizable

    • toString

      public String toString()
      Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
      Overrides:
      toString in class Object