se.entra.phantom.server.http

Class HttpCookie

java.lang.Object

se.entra.phantom.server.http.HttpCookie

public class HttpCookie
extends Object

Handles cookies from the server to the web browser and also cookies sent from the client in an HTTP request (GET or POST).

Cookies are a general mechanism which server side connections (such as CGI scripts) can use to both store and retrieve information on the client side of the connection. The addition of a simple, persistent, client-side state significantly extends the capabilities of Web-based client/server applications.

A server, when returning an HTTP object to a client, may also send a piece of state information which the client will store. Included in that state object is a description of the range of URLs for which that state is valid. Any future HTTP requests made by the client which fall in that range will include a transmittal of the current value of the state object from the client back to the server. The state object is called a cookie, for no compelling reason.

This simple mechanism provides a powerful new tool which enables a host of new types of applications to be written for web-based environments. Shopping applications can now store information about the currently selected items, for fee services can send back registration information and free the client from retyping a user-id on next connection, sites can store per-user preferences on the client, and have the client supply those preferences every time that site is connected to.

For a complete specification of the cookies, see RFC2109 or see the old (and different) HTTP/1.0 Netscape specification.

Note: Do not specify a name of the cookie starting with "$", it is reserved!

Field Summary

Fields

Modifier and Type	Field and Description
String	comment The comment of the cookie.
String	domain The domain of the cookie or null for none.
boolean	isSecure Flag indicating the cookie is only transferred when a secure connection exists.
boolean	isVersion1 The version of this cookie: true when using RFC2109 standard, false when using old Netscape version.
int	maxAge Timeout in seconds of the cookie (-1 if none or when validity date is specified).
String	name The name of the cookie.
String	path The path to the cookie or null if not specified.
Date	validity The valid until timestamp or null when not specified (for Netscape HTTP/1.0 cookie).
String	value The value of the cookie.

Constructor Summary

Constructors

Constructor and Description
HttpCookie(String name, String value) Creates a cookie to be transfered to the client in the next HTTP reply.
HttpCookie(String name, String value, boolean isVersion1) Creates a cookie to be transfered to the client in the next HTTP reply.
HttpCookie(String name, String value, String path, boolean isVersion1) Creates a cookie to be transfered to the client in the next HTTP reply.
HttpCookie(String name, String value, String path, String domain, boolean isVersion1) Creates a cookie to be transfered to the client in the next HTTP reply.
HttpCookie(String name, String value, String path, String domain, Date validity) Creates a cookie to be transfered to the client in the next HTTP reply.
HttpCookie(String name, String value, String comment, String path, String domain, Date validity, int maxAge, boolean isSecure, boolean isVersion1) Creates a cookie to be transfered to the client in the next HTTP reply.

Method Summary

Modifier and Type	Method and Description
String	getHeaderFieldData() Gets the string representation of this cookie for the server HTTP header field reply using "Set-Cookie: NAME=VALUE [; expires=DATE] [; path=PATH] [; domain=DOMAIN] [; secure] \r\n".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public final String name

The name of the cookie.

value

public final String value

The value of the cookie.

comment

public final String comment

The comment of the cookie.

path

public final String path

The path to the cookie or null if not specified.

domain

public final String domain

The domain of the cookie or null for none.

validity

public final Date validity

The valid until timestamp or null when not specified (for Netscape HTTP/1.0 cookie).

maxAge

public final int maxAge

Timeout in seconds of the cookie (-1 if none or when validity date is specified).

isVersion1

public final boolean isVersion1

The version of this cookie: true when using RFC2109 standard, false when using old Netscape version.

isSecure

public final boolean isSecure

Flag indicating the cookie is only transferred when a secure connection exists.

Constructor Detail

HttpCookie

public HttpCookie(String name,
                  String value)

Creates a cookie to be transfered to the client in the next HTTP reply.

This will create a cookie in the version 1 format.

HttpCookie

public HttpCookie(String name,
                  String value,
                  boolean isVersion1)

Creates a cookie to be transfered to the client in the next HTTP reply.

This will create a cookie in the version 1 format depending of the isVersion1 parameter.

HttpCookie

public HttpCookie(String name,
                  String value,
                  String path,
                  boolean isVersion1)

Creates a cookie to be transfered to the client in the next HTTP reply.

This will create a cookie in the version 1 format depending of the isVersion1 parameter.

HttpCookie

public HttpCookie(String name,
                  String value,
                  String path,
                  String domain,
                  boolean isVersion1)

Creates a cookie to be transfered to the client in the next HTTP reply.

This will create a cookie in the version 1 format depending of the isVersion1 parameter.

HttpCookie

public HttpCookie(String name,
                  String value,
                  String path,
                  String domain,
                  Date validity)

Creates a cookie to be transfered to the client in the next HTTP reply.

This will create a non-version 1 cookie in the old Netscape format.

HttpCookie

public HttpCookie(String name,
                  String value,
                  String comment,
                  String path,
                  String domain,
                  Date validity,
                  int maxAge,
                  boolean isSecure,
                  boolean isVersion1)

Creates a cookie to be transfered to the client in the next HTTP reply.

To use version 1 of the cookie, set validity=null and optionally specify maxAge to -1 or >=0.

Method Detail

getHeaderFieldData

public String getHeaderFieldData()

Gets the string representation of this cookie for the server HTTP header field reply using "Set-Cookie: NAME=VALUE [; expires=DATE] [; path=PATH] [; domain=DOMAIN] [; secure] \r\n".

The NAME and the VALUE are escaped using "%xx" URL style.