depends.org.apache.commons.httpclient.cookie

类 RFC2965Spec

java.lang.Object

depends.org.apache.commons.httpclient.cookie.CookieSpecBase

depends.org.apache.commons.httpclient.cookie.RFC2965Spec

所有已实现的接口:

CookieSpec, CookieVersionSupport

public class RFC2965Spec
extends CookieSpecBase
implements CookieVersionSupport

RFC 2965 specific cookie management functions.

从以下版本开始:

3.1

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SET_COOKIE2_KEY Cookie Response Header name for cookies processed by this spec.

从类继承的字段 depends.org.apache.commons.httpclient.cookie.CookieSpecBase

LOG

从接口继承的字段 depends.org.apache.commons.httpclient.cookie.CookieSpec

PATH_DELIM, PATH_DELIM_CHAR

构造器概要

构造器

构造器和说明
RFC2965Spec() Default constructor

方法概要

方法

限定符和类型	方法和说明
boolean	domainMatch(java.lang.String host, java.lang.String domain) Performs domain-match as defined by the RFC2965.
protected CookieAttributeHandler	findAttribHandler(java.lang.String name) Finds an attribute handler CookieAttributeHandler for the given attribute.
java.lang.String	formatCookie(Cookie cookie) Return a string suitable for sending in a "Cookie" header as defined in RFC 2965
java.lang.String	formatCookies(Cookie[] cookies) Create a RFC 2965 compliant "Cookie" header value containing all Cookies suitable for sending in a "Cookie" header
protected CookieAttributeHandler	getAttribHandler(java.lang.String name) Gets attribute handler CookieAttributeHandler for the given attribute.
protected java.util.Iterator	getAttribHandlerIterator()
int	getVersion()
Header	getVersionHeader()
boolean	match(java.lang.String host, int port, java.lang.String path, boolean secure, Cookie cookie) Return true if the cookie should be submitted with a request with given attributes, false otherwise.
Cookie[]	parse(java.lang.String host, int port, java.lang.String path, boolean secure, Header header) Parses the Set-Cookie2 value into an array of Cookies.
Cookie[]	parse(java.lang.String host, int port, java.lang.String path, boolean secure, java.lang.String header) Parses the Set-Cookie value into an array of Cookies.
void	parseAttribute(NameValuePair attribute, Cookie cookie) Parse RFC 2965 specific cookie attribute and update the corresponsing Cookie properties.
protected void	registerAttribHandler(java.lang.String name, CookieAttributeHandler handler)
void	validate(java.lang.String host, int port, java.lang.String path, boolean secure, Cookie cookie) Performs RFC 2965 compliant Cookie validation

从类继承的方法 depends.org.apache.commons.httpclient.cookie.CookieSpecBase

formatCookieHeader, formatCookieHeader, getValidDateFormats, match, pathMatch, setValidDateFormats

从类继承的方法 java.lang.Object

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

字段详细资料

SET_COOKIE2_KEY

public static final java.lang.String SET_COOKIE2_KEY

Cookie Response Header name for cookies processed by this spec.

另请参阅:

常量字段值

构造器详细资料

RFC2965Spec

public RFC2965Spec()

Default constructor

方法详细资料

registerAttribHandler

protected void registerAttribHandler(java.lang.String name,
                         CookieAttributeHandler handler)

findAttribHandler

protected CookieAttributeHandler findAttribHandler(java.lang.String name)

Finds an attribute handler CookieAttributeHandler for the given attribute. Returns null if no attribute handler is found for the specified attribute.

参数:

name - attribute name. e.g. Domain, Path, etc.

返回:

an attribute handler or null

getAttribHandler

protected CookieAttributeHandler getAttribHandler(java.lang.String name)

Gets attribute handler CookieAttributeHandler for the given attribute.

参数:

name - attribute name. e.g. Domain, Path, etc.

抛出:

java.lang.IllegalStateException - if handler not found for the specified attribute.

getAttribHandlerIterator

protected java.util.Iterator getAttribHandlerIterator()

parse

public Cookie[] parse(java.lang.String host,
             int port,
             java.lang.String path,
             boolean secure,
             Header header)
               throws MalformedCookieException

Parses the Set-Cookie2 value into an array of Cookies.

The syntax for the Set-Cookie2 response header is:

 set-cookie      =    "Set-Cookie2:" cookies
 cookies         =    1#cookie
 cookie          =    NAME "=" VALUE * (";" cookie-av)
 NAME            =    attr
 VALUE           =    value
 cookie-av       =    "Comment" "=" value
                 |    "CommentURL" "=" <"> http_URL <">
                 |    "Discard"
                 |    "Domain" "=" value
                 |    "Max-Age" "=" value
                 |    "Path" "=" value
                 |    "Port" [ "=" <"> portlist <"> ]
                 |    "Secure"
                 |    "Version" "=" 1*DIGIT
 portlist        =       1#portnum
 portnum         =       1*DIGIT
 

指定者:

parse 在接口中 CookieSpec

覆盖:

parse 在类中 CookieSpecBase

参数:

host - the host from which the Set-Cookie2 value was received

port - the port from which the Set-Cookie2 value was received

path - the path from which the Set-Cookie2 value was received

secure - true when the Set-Cookie2 value was received over secure conection

header - the Set-Cookie2 Header received from the server

返回:

an array of Cookies parsed from the Set-Cookie2 value

抛出:

MalformedCookieException - if an exception occurs during parsing

另请参阅:

CookieSpec.validate(String, int, String, boolean, Cookie)

parse

public Cookie[] parse(java.lang.String host,
             int port,
             java.lang.String path,
             boolean secure,
             java.lang.String header)
               throws MalformedCookieException

从类复制的说明: CookieSpecBase

Parses the Set-Cookie value into an array of Cookies.

The syntax for the Set-Cookie response header is:

 set-cookie      =    "Set-Cookie:" cookies
 cookies         =    1#cookie
 cookie          =    NAME "=" VALUE * (";" cookie-av)
 NAME            =    attr
 VALUE           =    value
 cookie-av       =    "Comment" "=" value
                 |    "Domain" "=" value
                 |    "Max-Age" "=" value
                 |    "Path" "=" value
                 |    "Secure"
                 |    "Version" "=" 1*DIGIT
 

指定者:

parse 在接口中 CookieSpec

覆盖:

parse 在类中 CookieSpecBase

参数:

host - the host from which the Set-Cookie value was received

port - the port from which the Set-Cookie value was received

path - the path from which the Set-Cookie value was received

secure - true when the Set-Cookie value was received over secure conection

header - the Set-Cookie received from the server

返回:

an array of Cookies parsed from the Set-Cookie value

抛出:

MalformedCookieException - if an exception occurs during parsing

另请参阅:

parse(String, int, String, boolean, depends.org.apache.commons.httpclient.Header)

parseAttribute

public void parseAttribute(NameValuePair attribute,
                  Cookie cookie)
                    throws MalformedCookieException

Parse RFC 2965 specific cookie attribute and update the corresponsing Cookie properties.

指定者:

parseAttribute 在接口中 CookieSpec

覆盖:

parseAttribute 在类中 CookieSpecBase

参数:

attribute - NameValuePair cookie attribute from the Set-Cookie2 header.

cookie - Cookie to be updated

抛出:

MalformedCookieException - if an exception occurs during parsing

validate

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

Performs RFC 2965 compliant Cookie validation

指定者:

validate 在接口中 CookieSpec

覆盖:

validate 在类中 CookieSpecBase

参数:

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

cookie - The cookie to validate

抛出:

MalformedCookieException - if an exception occurs during validation

match

public boolean match(java.lang.String host,
            int port,
            java.lang.String path,
            boolean secure,
            Cookie cookie)

Return true if the cookie should be submitted with a request with given attributes, false otherwise.

指定者:

match 在接口中 CookieSpec

覆盖:

match 在类中 CookieSpecBase

参数:

host - the host to which the request is being submitted

port - the port to which the request is being submitted (ignored)

path - the path to which the request is being submitted

secure - true if the request is using a secure connection

cookie - Cookie to be matched

返回:

true if the cookie matches the criterium

formatCookie

public java.lang.String formatCookie(Cookie cookie)

Return a string suitable for sending in a "Cookie" header as defined in RFC 2965

指定者:

formatCookie 在接口中 CookieSpec

覆盖:

formatCookie 在类中 CookieSpecBase

参数:

cookie - a Cookie to be formatted as string

返回:

a string suitable for sending in a "Cookie" header.

formatCookies

public java.lang.String formatCookies(Cookie[] cookies)

Create a RFC 2965 compliant "Cookie" header value containing all Cookies suitable for sending in a "Cookie" header

指定者:

formatCookies 在接口中 CookieSpec

覆盖:

formatCookies 在类中 CookieSpecBase

参数:

cookies - an array of Cookies to be formatted

返回:

a string suitable for sending in a Cookie header.

domainMatch

public boolean domainMatch(java.lang.String host,
                  java.lang.String domain)

Performs domain-match as defined by the RFC2965.

Host A's name domain-matches host B's if

their host name strings string-compare equal; or
A is a HDN string and has the form NB, where N is a non-empty name string, B has the form .B', and B' is a HDN string. (So, x.y.com domain-matches .Y.com but not Y.com.)

指定者:

domainMatch 在接口中 CookieSpec

覆盖:

domainMatch 在类中 CookieSpecBase

参数:

host - host name where cookie is received from or being sent to.

domain - The cookie domain attribute.

返回:

true if the specified host matches the given domain.

getVersion

public int getVersion()

指定者:

getVersion 在接口中 CookieVersionSupport

getVersionHeader

public Header getVersionHeader()

指定者:

getVersionHeader 在接口中 CookieVersionSupport