CookieSpec Interface Reference

Defines the cookie management specification. More...

Inheritance diagram for CookieSpec:

Description

Cookie management specification must define

• rules of parsing "Set-Cookie" header
• rules of validation of parsed cookies
• formatting of "Cookie" header

for a given host, port and path of origin

Author

Oleg Kalnichevski

Jeff Dever

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
int	getVersion ()
	Returns version of the state management this cookie specification conforms to. More...
List< Cookie >	parse (Header header, CookieOrigin origin) throws MalformedCookieException
	Parse the "Set-Cookie" Header into an array of Cookies. More...
void	validate (Cookie cookie, CookieOrigin origin) throws MalformedCookieException
	Validate the cookie according to validation rules defined by the cookie specification. More...
boolean	match (Cookie cookie, CookieOrigin origin)
	Determines if a Cookie matches the target location. More...
List< Header >	formatCookies (List< Cookie > cookies)
	Create "Cookie" headers for an array of Cookies. More...
Header	getVersionHeader ()
	Returns a request header identifying what version of the state management specification is understood. More...

Member Function Documentation

getVersion()

int getVersion

(

)

Returns

version of the state management specification

Implemented in RFC2965Spec, RFC2109Spec, BrowserCompatSpec, BestMatchSpec, and NetscapeDraftSpec.

parse()

List<Cookie> parse	(	Header	header,
		CookieOrigin	origin
	)		throws MalformedCookieException

This method will not perform the validation of the resultant com.good.gd.apache.http.cookie.Cookie

See also

validate

Parameters

header	the Set-Cookie received from the server
origin	details of the cookie origin

Returns

an array of Cookies parsed from the header

Exceptions

MalformedCookieException

if an exception occurs during parsing

Implemented in NetscapeDraftSpec, BrowserCompatSpec, RFC2109Spec, BestMatchSpec, and RFC2965Spec.

validate()

void validate	(	Cookie	cookie,
		CookieOrigin	origin
	)		throws MalformedCookieException

Parameters

cookie	the Cookie to validate
origin	details of the cookie origin

Exceptions

MalformedCookieException

if the cookie is invalid

Implemented in BestMatchSpec, CookieSpecBase, RFC2109Spec, and RFC2965Spec.

match()

boolean match	(	Cookie	cookie,
		CookieOrigin	origin
	)

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.

Implemented in BestMatchSpec, CookieSpecBase, and RFC2965Spec.

formatCookies()

List<Header> formatCookies

(

List< Cookie >

cookies

)

Parameters

cookies

the Cookies format into a Cookie header

Returns

a Header for the given Cookies.

Exceptions

IllegalArgumentException

if an input parameter is illegal

Implemented in RFC2109Spec, BestMatchSpec, BrowserCompatSpec, and NetscapeDraftSpec.

getVersionHeader()

Header getVersionHeader

(

)

May be null if the cookie specification does not support Cookie2 header.

Implemented in RFC2965Spec, RFC2109Spec, BrowserCompatSpec, BestMatchSpec, and NetscapeDraftSpec.