Android
org.apache.http.cookie
public interface

org.apache.http.cookie.CookieSpec

org.apache.http.cookie.CookieSpec

Defines the cookie management specification.

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

Summary

Public Methods

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

Details

Public Methods

public List<Header> formatCookies(List<Cookie> cookies)

Create "Cookie" headers for an array of Cookies.

Parameters

cookies the Cookies format into a Cookie header

Returns

  • a Header for the given Cookies.

Throws

IllegalArgumentException if an input parameter is illegal

public int getVersion()

Returns version of the state management this cookie specification conforms to.

Returns

  • version of the state management specification

public Header getVersionHeader()

Returns a request header identifying what version of the state management specification is understood. May be null if the cookie specification does not support Cookie2 header.

public boolean match(Cookie cookie, CookieOrigin origin)

Determines if a Cookie matches the target location.

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.

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

Parse the "Set-Cookie" Header into an array of Cookies.

This method will not perform the validation of the resultant Cookies

Parameters

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

Returns

  • an array of Cookies parsed from the header

Throws

MalformedCookieException if an exception occurs during parsing

public void validate(Cookie cookie, CookieOrigin origin)

Validate the cookie according to validation rules defined by the cookie specification.

Parameters

cookie the Cookie to validate
origin details of the cookie origin

Throws

MalformedCookieException if the cookie is invalid
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56