RFC 2109 compliant cookie policy. More...

Inheritance diagram for RFC2109Spec:

Description

Author: B.C. Holmes; Park, Sung-Gu; Doug Sale; Rod Waldhoff; dIon Gillard; Sean C. Sullivan; John Evans; Marc A. Saegesser; Oleg Kalnichevski; Mike Bowler

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
	RFC2109Spec (final String[] datepatterns, boolean oneHeader)
	Default constructor.

	RFC2109Spec ()
	Default constructor.

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...

List< Header >	formatCookies (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...

Public Member Functions inherited from CookieSpecBase
boolean	match (final Cookie cookie, final CookieOrigin origin)
	Determines if a Cookie matches the target location. More...

Public Member Functions inherited from AbstractCookieSpec
	AbstractCookieSpec ()
	Default constructor.

Protected Member Functions
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...

void	formatCookieAsVer (final CharArrayBuffer buffer, final Cookie cookie, int version)
	Return a 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...

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.

Reimplemented in RFC2965Spec.

◆ 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

Reimplemented from CookieSpecBase.

Reimplemented in 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

Implements CookieSpec.

◆ formatParamAsVer()

void formatParamAsVer	(	final CharArrayBuffer	buffer,
		final String	name,
		final String	value,
		int	version
	)

protected

Parameters

buffer	The char array buffer to use for output
name	The cookie name
value	The cookie value
version	The cookie version

◆ formatCookieAsVer()

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

protected

Parameters

buffer	The char array buffer to use for output
cookie	The com.good.gd.apache.http.cookie.Cookie to be formatted as string
version	The version to use.

Reimplemented in RFC2965Spec.

◆ getVersion()

int getVersion ( )

Returns: version of the state management specification

Implements CookieSpec.

Reimplemented in RFC2965Spec.

◆ getVersionHeader()

Header getVersionHeader ( )

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

Implements CookieSpec.

Reimplemented in RFC2965Spec.

Description

Notice

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ parse()

◆ validate()

◆ formatCookies()

◆ formatParamAsVer()

◆ formatCookieAsVer()

◆ getVersion()

◆ getVersionHeader()