RFC2965Spec Class Reference

Inheritance diagram for RFC2965Spec:

Description

RFC 2965 specific cookie management functions.

Author

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

Oleg Kalnichevski

Since

3.1

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
	RFC2965Spec ()
	Default constructor. More...
List< Cookie >	parse (final Header header, CookieOrigin origin) throws MalformedCookieException
	Parse the "Set-Cookie" Header into an array of Cookies. More...
void	validate (final Cookie cookie, CookieOrigin origin) throws MalformedCookieException
	Validate the cookie according to validation rules defined by the cookie specification. More...
boolean	match (final Cookie cookie, CookieOrigin origin)
	Determines if a Cookie matches the target location. 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...
Public Member Functions inherited from RFC2109Spec
	RFC2109Spec (final String[] datepatterns, boolean oneHeader)
	Default constructor.
	RFC2109Spec ()
	Default constructor.
List< Header >	formatCookies (List< Cookie > cookies)
	Create "Cookie" headers for an array of Cookies. More...
Public Member Functions inherited from AbstractCookieSpec
	AbstractCookieSpec ()
	Default constructor.

Protected Member Functions
void	formatCookieAsVer (final CharArrayBuffer buffer, final Cookie cookie, int version)
	Adds valid Port attribute value, e.g. More...
Protected Member Functions inherited from RFC2109Spec
void	formatParamAsVer (final CharArrayBuffer buffer, final String name, final String value, int version)
	Return a name/value string suitable for sending in a "Cookie" header as defined in RFC 2109 for backward compatibility with cookie version 0. More...
Protected Member Functions inherited from AbstractCookieSpec
CookieAttributeHandler	findAttribHandler (final String name)
	Finds an attribute handler com.good.gd.apache.http.cookie.CookieAttributeHandler for the given attribute. More...
CookieAttributeHandler	getAttribHandler (final String name)
	Gets attribute handler com.good.gd.apache.http.cookie.CookieAttributeHandler for the given attribute. More...

Constructor & Destructor Documentation

RFC2965Spec()

RFC2965Spec

(

)

Member Function Documentation

parse()

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

Reimplemented from RFC2109Spec.

validate()

void validate	(	final 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

Reimplemented from RFC2109Spec.

match()

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

Reimplemented from CookieSpecBase.

formatCookieAsVer()

void formatCookieAsVer ( final CharArrayBuffer  buffer, final Cookie  cookie, int  version  )

protected

"8000,8001,8002"

Reimplemented from RFC2109Spec.

getVersion()

int getVersion

(

)

Returns

version of the state management specification

Reimplemented from RFC2109Spec.

getVersionHeader()

Header getVersionHeader

(

)

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

Reimplemented from RFC2109Spec.