View Javadoc

1   /*
2    * $HeadURL:https://svn.apache.org/repos/asf/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/cookie/CookieAttributeHandler.java $
3    * $Revision:400312 $
4    * $Date:2006-05-06 14:49:41 +0200 (Sat, 06 May 2006) $
5    *
6    * ====================================================================
7    *
8    *  Copyright 1999-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  package org.apache.commons.httpclient.cookie;
30  
31  import org.apache.commons.httpclient.Cookie;
32  
33  /***
34   * Ths interface represents a cookie attribute handler responsible
35   * for parsing, validating, and matching a specific cookie attribute, 
36   * such as path, domain, port, etc.
37   *
38   * Different cookie specifications can provide a specific
39   * implementation for this class based on their cookie handling
40   * rules.
41   *
42   * @author jain.samit@gmail.com (Samit Jain)
43   * 
44   * @since 3.1
45   */
46  public interface CookieAttributeHandler {
47  
48    /***
49     * Parse the given cookie attribute value and update the corresponding
50     * {@link org.apache.commons.httpclient.Cookie} property.
51     *
52     * @param cookie {@link org.apache.commons.httpclient.Cookie} to be updated
53     * @param value cookie attribute value from the cookie response header
54     */
55    void parse(Cookie cookie, String value)
56            throws MalformedCookieException;
57  
58    /***
59     * Peforms cookie validation for the given attribute value.
60     *
61     * @param cookie {@link org.apache.commons.httpclient.Cookie} to validate
62     * @param origin the cookie source to validate against
63     * @throws MalformedCookieException if cookie validation fails for this attribute
64     */
65    void validate(Cookie cookie, CookieOrigin origin)
66            throws MalformedCookieException;
67  
68    /***
69     * Matches the given value (property of the destination host where request is being
70     * submitted) with the corresponding cookie attribute.
71     *
72     * @param cookie {@link org.apache.commons.httpclient.Cookie} to match
73     * @param origin the cookie source to match against
74     * @return <tt>true</tt> if the match is successful; <tt>false</tt> otherwise
75     */
76    boolean match(Cookie cookie, CookieOrigin origin);
77  
78  }