## helma.Http.Cookie

    Object
       |
       +--helma.Http.Cookie

Instances of this object represent a HTTP cookie
Defined in Http.js

SUMMARY: Constructor | Properties | Methods | DETAIL: Constructor | Properties | Methods

Constructor Summary
`helma.Http.Cookie(<String> name, <String> value)` Creates a new instance of helma.Http.Cookie

Properties Summary
`String` | `domain` An optional domain where this cookie is valid
`Date` | `expires` An optional date defining the lifetime of this cookie
`String` | `name` The name of the Cookie
`String` | `path` An optional path where this cookie is valid
`String` | `value` The value of the Cookie
`<static> <final> java.text.SimpleDateFormat` | `DATEFORMAT` An instance of java.text.SimpleDateFormat used for both parsing an "expires" string into a date and vice versa
`<static> <final> RegExp` | `PATTERN` A regular expression used for parsing cookie strings

Methods Summary
`String` | `getFieldValue()` Returns this cookie in a format useable to set the HTTP header field "Cookie"
`<static> helma.Http.Cookie` | `parse(<String> cookieStr)` Parses the cookie string passed as argument into an instance of helma.Http

Constructor Detail

### helma.Http.Cookie

    helma.Http.Cookie(<String> name, <String> value)

Creates a new instance of helma.Http.Cookie

Parameters:

`name` - The name of the cookie

`value` - The value of the cookie

Returns:

A newly created Cookie instance

Properties Detail

### domain

    String domain

An optional domain where this cookie is valid

### expires

    Date expires

An optional date defining the lifetime of this cookie

### name

    String name

The name of the Cookie

### path

    String path

An optional path where this cookie is valid

### value

    String value

The value of the Cookie

### DATEFORMAT

    <static> <final> java.text.SimpleDateFormat DATEFORMAT

An instance of java.text.SimpleDateFormat used for both parsing an "expires" string into a date and vice versa

### PATTERN

    <static> <final> RegExp PATTERN

A regular expression used for parsing cookie strings

Method Detail

### getFieldValue

    String getFieldValue()

Returns this cookie in a format useable to set the HTTP header field "Cookie"

Returns:

This cookie formatted as HTTP header field value

### parse

    <static> helma.Http.Cookie parse(<String> cookieStr)

Parses the cookie string passed as argument into an instance of helma.Http

Parameters:

`cookieStr` - The cookie string as received from the remote server

Returns:

An instance of helma.Http.Cookie containing the cookie parameters

SUMMARY: Constructor | Properties | Methods | DETAIL: Constructor | Properties | Methods

Documentation generated by JSDoc on Thu Apr 5 01:59:00 2007