HTTP_COOKIE

The HTTP_COOKIE element contains any HTTP cookie definitions for an application. The main goal of cookies is to keep a state, through session variables, between two runs of an application by the same user. The number of cookies associated with an application should be constant.

The HTTP_COOKIE element takes a mandatory Id attribute and four optional attributes Expires, Domain, Secure and HttpOnly.

Expires attribute indicates the cookie expiration date.
Domain attribute restricts the cookie to a specified domain.
When set to TRUE, Secure attribute restricts the cookie to secured connections only.
When set to TRUE, HttpOnly attribute disables the cookie access from client-side scripting langage like JavaScript™ running in a browser.

The HTTP_COOKIE element can have zero or more elements VARIABLE and CONSTANT. Each VARIABLE or CONSTANT element is defined by a mandatory identifier and an optional value.

Syntax

  <HTTP_COOKIE Id="cid" [Expires="endTime" | Domain="mydomain" | 
   Secure="TRUE|FALSE" | HttpOnly=""]>
    <VARIABLE Id="varId">val</VARIABLE> [...]
    <CONSTANT Id="cstId">cst</CONSTANT> [...]
  <HTTP_COOKIE> [...]

Syntax notes

cid is the cookie name.
endTime is cookie expiration in "Wdy, DD-Mon-YYYY HH:MM:SS GMT" format. You can set a relative date with "+X" or "X" where X represent a number of seconds. "X" will fix the cookie date only at the creation time and "+X" will regenerate a new date for the cookie on each HTTP request. (optional).
mydomain is the domain name the cookie is restricted to.
Secure restrict the cookie to secure connection HTTPS only. Valid values are TRUE or FALSE. (optional).
HttpOnly disallows accessing the cookie from client-side scripting language like JavaScript running in a browser. Valid values are TRUE or FALSE. (optional).
varId is the variable name and val its value.
cstId is the constant name and cst its value.

Child elements

The HTTP_COOKIE element may contain the following child elements:

Zero to many CONSTANT elements
Zero to many VARIABLE elements

Example

<!-- secure persistent cookie with default variable value and constant value -->
<HTTP_COOKIES>
  <HTTP_COOKIE Id="cookie3" Expires="Wdy, DD-Mon-YYYY HH:MM:SS GMT" 
   Domain="www.domain.com" Secure="TRUE" HttpOnly="TRUE">
    <VARIABLE Id="var7" />
    <VARIABLE Id="var8">Initial value</VARIABLE>
    <CONSTANT Id="constant1">A value</CONSTANT>
  </HTTP_COOKIE>
</HTTP_COOKIES>