HTTPCookie

Home > Books > NetKernel API and Services Reference > Accessor Listing > HTTP Transport > HTTPCookie

Module

The HTTPCookie accessor is exported by the urn:org:ten60:netkernel:tpt:http module. Import this module to gain access to the accessor.

Syntax

URI

active:HTTPCookie

Argument	Rules	Description
operand	Mandatory	for get this is `this:param:cookie`, for set this is the resource to attach the cookie to.
operator	Mandatory	the cookie argument
param	Optional	[Set Only]An XML cookie to be set

Example Usage

DPML

<instr>
  <type>HTTPCookie</type>
  <operand>this:param:cookie</operand>
  <operator>
    <cookie>
      <get>myCookie</get>
    </cookie>
  </operator>
  <target>var:cookie</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:HTTPCookie");
req.addArgument("operand", [resource representation, aspect, or URI] );
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The HTTPCookie accessor gets, sets or checks for the existance of Cookies on the HTTP transport. It generates and consumes cookie data in an XML form making it easy to process cookies in a general XML application. The XML form of a cookie is

<cookie>
  <name>somecookieid</name>
  <value>some value</value>
  <path>somepath</path>
  <domain>somedomain</domain>
  <secure>is secure</secure>
  <maxage>some expiry</maxage>
  <comment>some comment</comment>
</cookie>

The elements name and value are mandatory, other elements can optionally be set.

If set is used an XMLized cookie must be provided as the param on the instruction and the resource to attached the cookie to is provided as the operand argument. The result is a MultiPart aspect containing the operand resource and the cookie - this should be returned to the HTTPBridge for writing to into the HTTP response.

Operator Syntax

The HTTPCookie accessor takes an operator argument which indicates whether to get, set or test for the existance of a cookie. If get or exists is used the element must contain the name of the cookie to retrieve.

<cookie>
  <set /> or 
  <get>cookieName</get> or 
  <exists>cookieName</exists>
</cookie>