mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/CookieAttributeHandler.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/CookieAttributeHandler.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,73 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + * Licensed to the Apache Software Foundation (ASF) under one
     1.7 + * or more contributor license agreements.  See the NOTICE file
     1.8 + * distributed with this work for additional information
     1.9 + * regarding copyright ownership.  The ASF licenses this file
    1.10 + * to you under the Apache License, Version 2.0 (the
    1.11 + * "License"); you may not use this file except in compliance
    1.12 + * with the License.  You may obtain a copy of the License at
    1.13 + *
    1.14 + *   http://www.apache.org/licenses/LICENSE-2.0
    1.15 + *
    1.16 + * Unless required by applicable law or agreed to in writing,
    1.17 + * software distributed under the License is distributed on an
    1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    1.19 + * KIND, either express or implied.  See the License for the
    1.20 + * specific language governing permissions and limitations
    1.21 + * under the License.
    1.22 + * ====================================================================
    1.23 + *
    1.24 + * This software consists of voluntary contributions made by many
    1.25 + * individuals on behalf of the Apache Software Foundation.  For more
    1.26 + * information on the Apache Software Foundation, please see
    1.27 + * <http://www.apache.org/>.
    1.28 + *
    1.29 + */
    1.30 +package ch.boye.httpclientandroidlib.cookie;
    1.31 +
    1.32 +/**
    1.33 + * This interface represents a cookie attribute handler responsible
    1.34 + * for parsing, validating, and matching a specific cookie attribute,
    1.35 + * such as path, domain, port, etc.
    1.36 + *
    1.37 + * Different cookie specifications can provide a specific
    1.38 + * implementation for this class based on their cookie handling
    1.39 + * rules.
    1.40 + *
    1.41 + *
    1.42 + * @since 4.0
    1.43 + */
    1.44 +public interface CookieAttributeHandler {
    1.45 +
    1.46 +  /**
    1.47 +   * Parse the given cookie attribute value and update the corresponding
    1.48 +   * {@link ch.boye.httpclientandroidlib.cookie.Cookie} property.
    1.49 +   *
    1.50 +   * @param cookie {@link ch.boye.httpclientandroidlib.cookie.Cookie} to be updated
    1.51 +   * @param value cookie attribute value from the cookie response header
    1.52 +   */
    1.53 +  void parse(SetCookie cookie, String value)
    1.54 +          throws MalformedCookieException;
    1.55 +
    1.56 +  /**
    1.57 +   * Peforms cookie validation for the given attribute value.
    1.58 +   *
    1.59 +   * @param cookie {@link ch.boye.httpclientandroidlib.cookie.Cookie} to validate
    1.60 +   * @param origin the cookie source to validate against
    1.61 +   * @throws MalformedCookieException if cookie validation fails for this attribute
    1.62 +   */
    1.63 +  void validate(Cookie cookie, CookieOrigin origin)
    1.64 +          throws MalformedCookieException;
    1.65 +
    1.66 +  /**
    1.67 +   * Matches the given value (property of the destination host where request is being
    1.68 +   * submitted) with the corresponding cookie attribute.
    1.69 +   *
    1.70 +   * @param cookie {@link ch.boye.httpclientandroidlib.cookie.Cookie} to match
    1.71 +   * @param origin the cookie source to match against
    1.72 +   * @return <tt>true</tt> if the match is successful; <tt>false</tt> otherwise
    1.73 +   */
    1.74 +  boolean match(Cookie cookie, CookieOrigin origin);
    1.75 +
    1.76 +}

mercurial