org.apache.http.impl.cookie

Class CookieSpecBase

java.lang.Object

org.apache.http.impl.cookie.AbstractCookieSpec

org.apache.http.impl.cookie.CookieSpecBase

All Implemented Interfaces:

CookieSpec

Direct Known Subclasses:

BrowserCompatSpec, IgnoreSpec, NetscapeDraftSpec, RFC2109Spec

public abstract class CookieSpecBase
extends AbstractCookieSpec

Cookie management functions shared by all specification.

Since:

4.0

Constructor Summary

Constructors

Modifier	Constructor and Description
	CookieSpecBase()
protected	CookieSpecBase(CommonCookieAttributeHandler... handlers)
protected	CookieSpecBase(java.util.HashMap<java.lang.String,CookieAttributeHandler> map)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getDefaultDomain(CookieOrigin origin)
protected static java.lang.String	getDefaultPath(CookieOrigin origin)
boolean	match(Cookie cookie, CookieOrigin origin) Determines if a Cookie matches the target location.
protected java.util.List<Cookie>	parse(HeaderElement[] elems, CookieOrigin origin) Parse the "Set-Cookie" Header into an array of Cookies.
void	validate(Cookie cookie, CookieOrigin origin) Validate the cookie according to validation rules defined by the cookie specification.

Methods inherited from class org.apache.http.impl.cookie.AbstractCookieSpec

findAttribHandler, getAttribHandler, getAttribHandlers, registerAttribHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.cookie.CookieSpec

formatCookies, getVersion, getVersionHeader

Constructor Detail

CookieSpecBase

public CookieSpecBase()

CookieSpecBase

protected CookieSpecBase(java.util.HashMap<java.lang.String,CookieAttributeHandler> map)

Since:

4.4

CookieSpecBase

protected CookieSpecBase(CommonCookieAttributeHandler... handlers)

Since:

4.4

Method Detail

getDefaultPath

protected static java.lang.String getDefaultPath(CookieOrigin origin)

getDefaultDomain

protected static java.lang.String getDefaultDomain(CookieOrigin origin)

parse

protected java.util.List<Cookie> parse(HeaderElement[] elems,
                                       CookieOrigin origin)
                                throws MalformedCookieException

Description copied from interface: CookieSpec

Parse the "Set-Cookie" Header into an array of Cookies.

This method will not perform the validation of the resultant Cookies

Parameters:

elems - the Set-Cookie received from the server

origin - details of the cookie origin

Returns:

an array of Cookies parsed from the header

Throws:

MalformedCookieException - if an exception occurs during parsing

See Also:

CookieSpec.validate(org.apache.http.cookie.Cookie, org.apache.http.cookie.CookieOrigin)

validate

public void validate(Cookie cookie,
                     CookieOrigin origin)
              throws MalformedCookieException

Description copied from interface: CookieSpec

Validate the cookie according to validation rules defined by the cookie specification.

Parameters:

cookie - the Cookie to validate

origin - details of the cookie origin

Throws:

MalformedCookieException - if the cookie is invalid

match

public boolean match(Cookie cookie,
                     CookieOrigin origin)

Description copied from interface: CookieSpec

Determines if a Cookie matches the target location.

Parameters:

cookie - the Cookie to be matched

origin - the target to test against

Returns:

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