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