    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.www.http.HttpSetCookie

    java.lang.Object
       |
       +----org.w3c.www.http.HttpSetCookie

public class HttpSetCookie
extends Object

##

comment
  The cookie's comment.
domain
  The cookie's domain name.
maxage
  The cookie's max age.
name
  The cookie's name.
path
  The cookie's associated path.
security
  Does this cookie requires special security care by client ?
value
version
  This cookie's version.

##

HttpSetCookie()

##

getComment()
  Get this SetCookie attached comment.
getDomain()
  Get the domain to which this cookie applies.
getMaxAge()
  Get the max age value for this cookie.
getName()
  Get this SetCookie cookie's name.
getPath()
  Get the path in which this cookie will apply.
getSecurity()
  Get the security requirement atttached to that cookie.
getValue()
  Get the value associated with this SetCookie.
getVersion()
  Get the SetCookie version number.
setComment(String)
  Set this SetCookie attached comment.
setDomain(String)
  Define the domain for this SetCookie.
setMaxAge(int)
  Set the max age value for this cookie.
setName(String)
  Set this SetCookie name.
setPath(String)
  Set the path to which this SetCookie applies.
setSecurity(boolean)
  Mark/unmark this SetCookie as requiring special security when emited back by the client.
setValue(String)
  Set this SetCookie cookie's value.
setVersion(int)
  Set the SetCookie version number.

##

name

     protected String name

  The cookie's name.

value

     protected String value

comment

     protected String comment

  The cookie's comment.

domain

     protected String domain

  The cookie's domain name.

maxage

     protected int maxage

  The cookie's max age.

path

     protected String path

  The cookie's associated path.

security

     protected boolean security

  Does this cookie requires special security care by client ?

version

     protected int version

  This cookie's version.

##

HttpSetCookie

     public HttpSetCookie()

##

getComment

     public String getComment()

  Get this SetCookie attached comment.

  Returns:
    A String describing the reason for this SetCookie, or null.

setComment

     public void setComment(String comment)

  Set this SetCookie attached comment.

  Parameters:
    comment - A String giving the comments attached to that SetCookie, or null to reset the value.

getDomain

     public String getDomain()

  Get the domain to which this cookie applies.

  Returns:
    The string encoding of the domain to which this cookie applies or null if undefined.

setDomain

     public void setDomain(String domain)

  Define the domain for this SetCookie.

  Parameters:
    domain - The String encoded domain name to which this cookie will apply.

getMaxAge

     public int getMaxAge()

  Get the max age value for this cookie.

  Returns:
    A integer number of seconds giving the maximum age allowed for this cookie, or -1 if undefined.

setMaxAge

     public void setMaxAge(int maxage)

  Set the max age value for this cookie.

  Parameters:
    maxage - The max age value for this cookie, given as a number of seconds, or -1 to reset value.

getPath

     public String getPath()

  Get the path in which this cookie will apply.

  Returns:
    The path to which this cookie applies, encoded as a String, or null if undefined.

setPath

     public void setPath(String path)

  Set the path to which this SetCookie applies.

  Parameters:
    path - The path, encoded as a String.

getSecurity

     public boolean getSecurity()

  Get the security requirement atttached to that cookie.

  Returns:
    A boolean, true if the cookie requires special care from the client, false otherwise.

setSecurity

     public void setSecurity(boolean onoff)

  Mark/unmark this SetCookie as requiring special security when emited back by the client.

  Parameters:
    onoff - A boolean, true if the cookie that results should be emited with special care, false otherwise.

getVersion

     public int getVersion()

  Get the SetCookie version number.

  Returns:
    An integer giving the version number of this cookie.

setVersion

     public void setVersion(int version)

  Set the SetCookie version number.

  Parameters:
    version - The version number of this SetCookie.

setName

     public void setName(String name)

  Set this SetCookie name.

  Parameters:
    name - The name of the cookie, encoded as a String.

getName

     public String getName()

  Get this SetCookie cookie's name.

  Returns:
    A String giving the cookie's name.

setValue

     public void setValue(String value)

  Set this SetCookie cookie's value.

  Parameters:
    value - The value, encoded as a printable String, or null to reset the value.

getValue

     public String getValue()

  Get the value associated with this SetCookie.

  Returns:
    The value, encoded as a String, or null if undefined.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index