com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.cookie

类 CookieSpecBase

java.lang.Object

com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.cookie.CookieSpecBase

所有已实现的接口:

CookieSpec

直接已知子类:

NetscapeDraftSpec, RFC2109Spec

public class CookieSpecBase
extends Object
implements CookieSpec

Cookie management functions shared by all specification.

从以下版本开始:

2.0

作者:

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

字段概要

字段

限定符和类型	字段和说明
protected static org.apache.commons.logging.Log	LOG Log object

从接口继承的字段 com.ptteng.course.util.aliPayUtil.apacheCommonUtil.httpclient.cookie.CookieSpec

PATH_DELIM, PATH_DELIM_CHAR

构造器概要

构造器

构造器和说明
CookieSpecBase() Default constructor

方法概要

限定符和类型	方法和说明
boolean	domainMatch(String host, String domain) Performs domain-match as implemented in common browsers.
String	formatCookie(Cookie cookie) Return a string suitable for sending in a "Cookie" header
Header	formatCookieHeader(Cookie cookie) Create a "Cookie" Header containing the Cookie.
Header	formatCookieHeader(Cookie[] cookies) Create a "Cookie" Header containing all Cookies in cookies.
String	formatCookies(Cookie[] cookies) Create a "Cookie" header value containing all Cookies in cookies suitable for sending in a "Cookie" header
Collection	getValidDateFormats() Returns the Collection of date patterns used for parsing.
boolean	match(String host, int port, String path, boolean secure, Cookie cookie) Return true if the cookie should be submitted with a request with given attributes, false otherwise.
Cookie[]	match(String host, int port, String path, boolean secure, Cookie[] cookies) Return an array of Cookies that should be submitted with a request with given attributes, false otherwise.
Cookie[]	parse(String host, int port, String path, boolean secure, Header header) Parse the "Set-Cookie" Header into an array of Cookies.
Cookie[]	parse(String host, int port, String path, boolean secure, String header) Parses the Set-Cookie value into an array of Cookies.
void	parseAttribute(NameValuePair attribute, Cookie cookie) Parse the cookie attribute and update the corresponsing Cookie properties.
boolean	pathMatch(String path, String topmostPath) Performs path-match as implemented in common browsers.
void	setValidDateFormats(Collection datepatterns) Sets the Collection of date patterns used for parsing.
void	validate(String host, int port, String path, boolean secure, Cookie cookie) Performs most common Cookie validation

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

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

字段详细资料

LOG

protected static final org.apache.commons.logging.Log LOG

Log object

构造器详细资料

CookieSpecBase

public CookieSpecBase()

Default constructor

方法详细资料

parse

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

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

参数:

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

另请参阅:

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

parse

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

Parse the "Set-Cookie" Header 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

参数:

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

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

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

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

header - the Set-Cookie received from the server

返回:

an array of Cookies parsed from the "Set-Cookie" header

抛出:

MalformedCookieException - if an exception occurs during parsing

另请参阅:

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

parseAttribute

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

Parse the cookie attribute and update the corresponsing Cookie properties.

指定者:

parseAttribute 在接口中 CookieSpec

参数:

attribute - HeaderElement cookie attribute from the Set- Cookie

cookie - Cookie to be updated

抛出:

MalformedCookieException - if an exception occurs during parsing

getValidDateFormats

public Collection getValidDateFormats()

从接口复制的说明: CookieSpec

Returns the Collection of date patterns used for parsing. The String patterns are compatible with the SimpleDateFormat.

指定者:

getValidDateFormats 在接口中 CookieSpec

返回:

collection of date patterns

setValidDateFormats

public void setValidDateFormats(Collection datepatterns)

从接口复制的说明: CookieSpec

Sets the Collection of date patterns used for parsing. The String patterns must be compatible with SimpleDateFormat.

指定者:

setValidDateFormats 在接口中 CookieSpec

参数:

datepatterns - collection of date patterns

validate

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

Performs most common Cookie validation

指定者:

validate 在接口中 CookieSpec

参数:

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(String host,
                     int port,
                     String path,
                     boolean secure,
                     Cookie cookie)

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

指定者:

match 在接口中 CookieSpec

参数:

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

domainMatch

public boolean domainMatch(String host,
                           String domain)

Performs domain-match as implemented in common browsers.

指定者:

domainMatch 在接口中 CookieSpec

参数:

host - The target host.

domain - The cookie domain attribute.

返回:

true if the specified host matches the given domain.

pathMatch

public boolean pathMatch(String path,
                         String topmostPath)

Performs path-match as implemented in common browsers.

指定者:

pathMatch 在接口中 CookieSpec

参数:

path - The target path.

topmostPath - The cookie path attribute.

返回:

true if the paths match

match

public Cookie[] match(String host,
                      int port,
                      String path,
                      boolean secure,
                      Cookie[] cookies)

Return an array of Cookies that should be submitted with a request with given attributes, false otherwise.

指定者:

match 在接口中 CookieSpec

参数:

host - the host to which the request is being submitted

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

path - the path to which the request is being submitted

secure - true if the request is using a secure protocol

cookies - an array of Cookies to be matched

返回:

an array of Cookies matching the criterium

formatCookie

public String formatCookie(Cookie cookie)

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

指定者:

formatCookie 在接口中 CookieSpec

参数:

cookie - a Cookie to be formatted as string

返回:

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

formatCookies

public String formatCookies(Cookie[] cookies)
                     throws IllegalArgumentException

Create a "Cookie" header value containing all Cookies in cookies suitable for sending in a "Cookie" header

指定者:

formatCookies 在接口中 CookieSpec

参数:

cookies - an array of Cookies to be formatted

返回:

a string suitable for sending in a Cookie header.

抛出:

IllegalArgumentException - if an input parameter is illegal

formatCookieHeader

public Header formatCookieHeader(Cookie[] cookies)

Create a "Cookie" Header containing all Cookies in cookies.

指定者:

formatCookieHeader 在接口中 CookieSpec

参数:

cookies - an array of Cookies to be formatted as a " Cookie" header

返回:

a "Cookie" Header.

formatCookieHeader

public Header formatCookieHeader(Cookie cookie)

Create a "Cookie" Header containing the Cookie.

指定者:

formatCookieHeader 在接口中 CookieSpec

参数:

cookie - Cookies to be formatted as a Cookie header

返回:

a Cookie header.