BestMatchSpec Class Reference

'Meta' cookie specification that selects a cookie policy depending on the format of the cookie(s) More...

Inheritance diagram for BestMatchSpec:

Description

Author

Oleg Kalnichevski

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

Member Function Documentation

parse()

List<Cookie> parse	(	final Header	header,
		final 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

Implements CookieSpec.

validate()

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

Parameters

cookie	the Cookie to validate
origin	details of the cookie origin

Exceptions

MalformedCookieException

if the cookie is invalid

Implements CookieSpec.

match()

boolean match	(	final Cookie	cookie,
		final 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.

Implements CookieSpec.

formatCookies()

List<Header> formatCookies

(

final 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

Implements CookieSpec.

getVersion()

int getVersion

(

)

Returns

version of the state management specification

Implements CookieSpec.

getVersionHeader()

Header getVersionHeader

(

)

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

Implements CookieSpec.