org.apache.commons.httpclient.cookie
Class RFC2109Spec

java.lang.Object
  |
  +--org.apache.commons.httpclient.cookie.CookieSpecBase
        |
        +--org.apache.commons.httpclient.cookie.RFC2109Spec
All Implemented Interfaces:
CookieSpec

public class RFC2109Spec
extends CookieSpecBase

RFC 2109 specific cookie management functions

Since:
2.0
Author:
B.C. Holmes, Park, Sung-Gu, Doug Sale, Rod Waldhoff, dIon Gillard, Sean C. Sullivan, John Evans, Marc A. Saegesser, Oleg Kalnichevski

Field Summary
 
Fields inherited from class org.apache.commons.httpclient.cookie.CookieSpecBase
log
 
Fields inherited from interface org.apache.commons.httpclient.cookie.CookieSpec
PATH_DELIM, PATH_DELIM_CHAR
 
Constructor Summary
RFC2109Spec()
          Default constructor
 
Method Summary
 java.lang.String formatCookie(Cookie cookie)
          Return a string suitable for sending in a "Cookie" header as defined in RFC 2109
 Header formatCookieHeader(Cookie cookie)
          Create a RFC 2109 compliant "Cookie" Header containing the Cookie.
 java.lang.String formatCookies(Cookie[] cookies)
          Create a RFC 2109 compliant "Cookie" header value containing all Cookies in cookies suitable for sending in a "Cookie" header
 void parseAttribute(NameValuePair attribute, Cookie cookie)
          Parse RFC 2109 specific cookie attribute and update the corresponsing Cookie properties.
 void validate(java.lang.String host, int port, java.lang.String path, boolean secure, Cookie cookie)
          Performs RFC 2109 compliant Cookie validation
 
Methods inherited from class org.apache.commons.httpclient.cookie.CookieSpecBase
formatCookieHeader, match, match, parse, parse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RFC2109Spec

public RFC2109Spec()
Default constructor

Method Detail

parseAttribute

public void parseAttribute(NameValuePair attribute,
                           Cookie cookie)
                    throws MalformedCookieException
Parse RFC 2109 specific cookie attribute and update the corresponsing Cookie properties.

Specified by:
parseAttribute in interface CookieSpec
Overrides:
parseAttribute in class CookieSpecBase
Parameters:
attribute - NameValuePair cookie attribute from the Set-Cookie
cookie - Cookie to be updated
Throws:
MalformedCookieException - if an exception occurs during parsing
java.lang.IllegalArgumentException - if an input parameter is illegal

validate

public void validate(java.lang.String host,
                     int port,
                     java.lang.String path,
                     boolean secure,
                     Cookie cookie)
              throws MalformedCookieException
Performs RFC 2109 compliant Cookie validation

Specified by:
validate in interface CookieSpec
Overrides:
validate in class CookieSpecBase
Parameters:
host - the host from which the Cookie was received
port - the port from which the Cookie was received
path - the path from which the Cookie was received
secure - true when the Cookie was received using a secure connection
Throws:
MalformedCookieException - if an exception occurs during validation
java.lang.IllegalArgumentException - if an input parameter is illegal

formatCookie

public java.lang.String formatCookie(Cookie cookie)
Return a string suitable for sending in a "Cookie" header as defined in RFC 2109

Specified by:
formatCookie in interface CookieSpec
Overrides:
formatCookie in class CookieSpecBase
Returns:
a string suitable for sending in a "Cookie" header.

formatCookies

public java.lang.String formatCookies(Cookie[] cookies)
Create a RFC 2109 compliant "Cookie" header value containing all Cookies in cookies suitable for sending in a "Cookie" header

Specified by:
formatCookies in interface CookieSpec
Overrides:
formatCookies in class CookieSpecBase
Returns:
a string suitable for sending in a Cookie header.
Throws:
java.lang.IllegalArgumentException - if an input parameter is illegal

formatCookieHeader

public Header formatCookieHeader(Cookie cookie)
Create a RFC 2109 compliant "Cookie" Header containing the Cookie.

Specified by:
formatCookieHeader in interface CookieSpec
Overrides:
formatCookieHeader in class CookieSpecBase
Returns:
a Cookie header.
Throws:
java.lang.IllegalArgumentException - if an input parameter is illegal


Copyright © 2001-2003 Apache Software Foundation. All Rights Reserved.