CookieAttributeHandler Interface Reference

Ths interface represents a cookie attribute handler responsible for parsing, validating, and matching a specific cookie attribute, such as path, domain, port, etc. More...

Inheritance diagram for CookieAttributeHandler:

Description

Different cookie specifications can provide a specific implementation for this class based on their cookie handling rules.

Author

jain..nosp@m.sami.nosp@m.t@gma.nosp@m.il.c.nosp@m.om (Samit Jain)

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
void	parse (SetCookie cookie, String value) throws MalformedCookieException
	Parse the given cookie attribute value and update the corresponding com.good.gd.apache.http.cookie.Cookie property. More...
void	validate (Cookie cookie, CookieOrigin origin) throws MalformedCookieException
	Peforms cookie validation for the given attribute value. More...
boolean	match (Cookie cookie, CookieOrigin origin)
	Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute. More...

Member Function Documentation

parse()

void parse	(	SetCookie	cookie,
		String	value
	)		throws MalformedCookieException

Parameters

cookie	com.good.gd.apache.http.cookie.Cookie to be updated
value	cookie attribute value from the cookie response header

Implemented in BasicPathHandler, RFC2965DomainAttributeHandler, BasicExpiresHandler, RFC2965VersionAttributeHandler, RFC2109DomainHandler, BasicDomainHandler, BasicMaxAgeHandler, BasicSecureHandler, RFC2109VersionHandler, BasicCommentHandler, RFC2965PortAttributeHandler, RFC2965CommentUrlAttributeHandler, and RFC2965DiscardAttributeHandler.

validate()

void validate	(	Cookie	cookie,
		CookieOrigin	origin
	)		throws MalformedCookieException

Parameters

cookie	com.good.gd.apache.http.cookie.Cookie to validate
origin	the cookie source to validate against

Exceptions

MalformedCookieException

if cookie validation fails for this attribute

Implemented in RFC2965PortAttributeHandler, RFC2965DomainAttributeHandler, RFC2965VersionAttributeHandler, RFC2109VersionHandler, RFC2109DomainHandler, BasicDomainHandler, RFC2965CommentUrlAttributeHandler, RFC2965DiscardAttributeHandler, BasicPathHandler, NetscapeDomainHandler, and AbstractCookieAttributeHandler.

match()

boolean match	(	Cookie	cookie,
		CookieOrigin	origin
	)

Parameters

cookie	com.good.gd.apache.http.cookie.Cookie to match
origin	the cookie source to match against

Returns

true if the match is successful; false otherwise

Implemented in RFC2965DomainAttributeHandler, RFC2965PortAttributeHandler, RFC2109DomainHandler, BasicDomainHandler, RFC2965VersionAttributeHandler, BasicPathHandler, RFC2965CommentUrlAttributeHandler, RFC2965DiscardAttributeHandler, BasicSecureHandler, AbstractCookieAttributeHandler, NetscapeDomainHandler, and BasicExpiresHandler.