org.w3c.www.http
Class HttpSetCookieList

java.lang.Object
  org.w3c.www.http.BasicValue
      org.w3c.www.http.HttpSetCookieList

All Implemented Interfaces:

java.lang.Cloneable, HeaderValue

public class HttpSetCookieList
extends BasicValue

Field Summary

Fields inherited from class org.w3c.www.http.BasicValue

isValid, raw, rlen, roff

Constructor Summary

HttpSetCookieList(HttpSetCookie[] sc)

Method Summary

void	addBytes(byte[] buf, int off, int len) HeaderValue implementation - Add these bytes to the header raw value.
void	addSetCookie(HttpSetCookie setCookie)
HttpSetCookie	addSetCookie(java.lang.String name, java.lang.String value) Add a specific cookie to the SetCookie header value.
protected void	checkByteValues()
protected int	copyLength()
protected void	emitCookie(java.io.OutputStream out, int cookie)
protected void	emitCopyCookie(java.io.OutputStream out, int cookie)
HttpSetCookie	getSetCookie(java.lang.String name) Get the cookie infos associated with the given cookie name, if any.
HttpSetCookie[]	getSetCookies()
java.lang.Object	getValue() HeaderValue implemenntation - Get this header value.
protected boolean	isOriginal()
protected int	length()
protected void	parse() parse set cookie header according to the specification: http://www.netscape.com/newsref/std/cookie_spec.html
boolean	removeSetCookie(java.lang.String name) Remove a predefined cookie from this SetCookie header.
protected void	updateByteValue() Update the RFC822 compatible header value for this object.

Methods inherited from class org.w3c.www.http.BasicValue

appendValue, checkByteValue, clone, emit, error, invalidateByteValue, setBytes, setString, toExternalForm, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSetCookieList

public HttpSetCookieList(HttpSetCookie[] sc)

Method Detail

length

protected int length()

copyLength

protected int copyLength()

isOriginal

protected boolean isOriginal()

emitCookie

protected void emitCookie(java.io.OutputStream out,
                          int cookie)
                   throws java.io.IOException

Throws:

java.io.IOException

emitCopyCookie

protected void emitCopyCookie(java.io.OutputStream out,
                              int cookie)
                       throws java.io.IOException

Throws:

java.io.IOException

checkByteValues

protected final void checkByteValues()

updateByteValue

protected void updateByteValue()

Description copied from class: BasicValue

Update the RFC822 compatible header value for this object.

Specified by:

updateByteValue in class BasicValue

addBytes

public void addBytes(byte[] buf,
                     int off,
                     int len)

HeaderValue implementation - Add these bytes to the header raw value.

Specified by:

addBytes in interface HeaderValue

Overrides:

addBytes in class BasicValue

Parameters:

buf - The byte buffer containing some part of the header value.

off - The offset of the header value in above buffer.

len - The length of the header value in above buffer.

parse

protected void parse()
              throws HttpParserException

parse set cookie header according to the specification: http://www.netscape.com/newsref/std/cookie_spec.html

Specified by:

parse in class BasicValue

Throws:

HttpParserException - if parsing failed.

getValue

public java.lang.Object getValue()

Description copied from class: BasicValue

HeaderValue implemenntation - Get this header value.

Specified by:

getValue in interface HeaderValue

Specified by:

getValue in class BasicValue

Returns:

An object representing the parsed value for this header.

addSetCookie

public HttpSetCookie addSetCookie(java.lang.String name,
                                  java.lang.String value)

Add a specific cookie to the SetCookie header value. This method creates a new, empty SetCookie holder, attaches it to the SetCookie header, and returns it.

Parameters:

name - The cookie's name.

value - The cookie's value.

addSetCookie

public void addSetCookie(HttpSetCookie setCookie)

removeSetCookie

public boolean removeSetCookie(java.lang.String name)

Remove a predefined cookie from this SetCookie header.

Parameters:

name - The name of the cookie to remove.

Returns:

A boolean true if removed, false otherwise.

getSetCookie

public HttpSetCookie getSetCookie(java.lang.String name)

Get the cookie infos associated with the given cookie name, if any.

Parameters:

name - The cookie's name.

Returns:

A HttpSetCookie instance, if found, or null otherwise.

getSetCookies

public HttpSetCookie[] getSetCookies()