Cookie


This type is a class for model objects.

Configuration for session tracking through HTTP cookies. It is the most used session tracking mechanism. Servlet containers are required to support it. A container sends a cookie to the client. The client will return the cookie on each subsequent request to the server, to associate the request with a session.

Package: webcontainer

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  SessionManager.defaultCookieSettings



Attributes Summary
name : EString Specifies a unique name for the cookie. The name must be JSESSIONID as specified in the Servlet 2.2 API.
domain : EString The value of the domain field of a session tracking cookie. This value will restrict where the cookie is sent. For example, if we specify a particular domain, session cookies will be sent only to hosts in that domain.
maximumAge : EInt The amount of time that the cookie will live on the client browser. This value corresponds to the Time to Live (TTL) value described in the Cookie specification.
path : EString The paths (on the server) to which the session tracking cookie will be sent. Specify any string representing a path on the server. To indicate the root directory "/", leave the field blank.

Specify a value in order to restrict the paths to which the cookie will be sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If we specify the root directory, the cookie will be sent no matter which path on the given server is accessed.
secure : EBoolean Whether session cookies include the secure field. When enabled, restricts the exchange of cookies to only HTTPS sessions.



Attribute Details

name  -  Specifies a unique name for the cookie. The name must be JSESSIONID as specified in the Servlet 2.2 API.
    Data Type: EString
    Default value:  JSESSIONID
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

domain  -  The value of the domain field of a session tracking cookie. This value will restrict where the cookie is sent. For example, if we specify a particular domain, session cookies will be sent only to hosts in that domain.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maximumAge  -  The amount of time that the cookie will live on the client browser. This value corresponds to the Time to Live (TTL) value described in the Cookie specification.
    Data Type: EInt
    Default value:  -1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

path  -  The paths (on the server) to which the session tracking cookie will be sent. Specify any string representing a path on the server. To indicate the root directory "/", leave the field blank.

Specify a value in order to restrict the paths to which the cookie will be sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If we specify the root directory, the cookie will be sent no matter which path on the given server is accessed.
    Data Type: EString
    Default value:  /
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

secure  -  Whether session cookies include the secure field. When enabled, restricts the exchange of cookies to only HTTPS sessions.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006