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