001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.cookie;
028
029/**
030 * This interface represents a cookie attribute handler responsible
031 * for parsing, validating, and matching a specific cookie attribute,
032 * such as path, domain, port, etc.
033 *
034 * Different cookie specifications can provide a specific
035 * implementation for this class based on their cookie handling
036 * rules.
037 *
038 *
039 * @since 4.0
040 */
041public interface CookieAttributeHandler {
042
043  /**
044   * Parse the given cookie attribute value and update the corresponding
045   * {@link org.apache.http.cookie.Cookie} property.
046   *
047   * @param cookie {@link org.apache.http.cookie.Cookie} to be updated
048   * @param value cookie attribute value from the cookie response header
049   */
050  void parse(SetCookie cookie, String value)
051          throws MalformedCookieException;
052
053  /**
054   * Peforms cookie validation for the given attribute value.
055   *
056   * @param cookie {@link org.apache.http.cookie.Cookie} to validate
057   * @param origin the cookie source to validate against
058   * @throws MalformedCookieException if cookie validation fails for this attribute
059   */
060  void validate(Cookie cookie, CookieOrigin origin)
061          throws MalformedCookieException;
062
063  /**
064   * Matches the given value (property of the destination host where request is being
065   * submitted) with the corresponding cookie attribute.
066   *
067   * @param cookie {@link org.apache.http.cookie.Cookie} to match
068   * @param origin the cookie source to match against
069   * @return {@code true} if the match is successful; {@code false} otherwise
070   */
071  boolean match(Cookie cookie, CookieOrigin origin);
072
073}