org.apache.commons.httpclient.cookie

Interface CookieAttributeHandler

public interface CookieAttributeHandler

Ths interface represents a cookie attribute handler responsible for parsing, validating, and matching a specific cookie attribute, such as path, domain, port, etc. Different cookie specifications can provide a specific implementation for this class based on their cookie handling rules.

Since: 3.1

Author: jain.samit@gmail.com (Samit Jain)

Method Summary
booleanmatch(Cookie cookie, CookieOrigin origin)
Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute.
voidparse(Cookie cookie, String value)
Parse the given cookie attribute value and update the corresponding Cookie property.
voidvalidate(Cookie cookie, CookieOrigin origin)
Peforms cookie validation for the given attribute value.

Method Detail

match

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

Parameters: cookie Cookie to match origin the cookie source to match against

Returns: true if the match is successful; false otherwise

parse

public void parse(Cookie cookie, String value)
Parse the given cookie attribute value and update the corresponding Cookie property.

Parameters: cookie Cookie to be updated value cookie attribute value from the cookie response header

validate

public void validate(Cookie cookie, CookieOrigin origin)
Peforms cookie validation for the given attribute value.

Parameters: cookie Cookie to validate origin the cookie source to validate against

Throws: MalformedCookieException if cookie validation fails for this attribute

Copyright (c) 1999-2005 - Apache Software Foundation