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 org.apache.hc.client5.http.cookie; 28 29 import org.apache.hc.core5.annotation.Contract; 30 import org.apache.hc.core5.annotation.ThreadingBehavior; 31 32 /** 33 * This interface represents a cookie attribute handler responsible 34 * for parsing, validating, and matching a specific cookie attribute, 35 * such as path, domain, port, etc. 36 * <p> 37 * Different cookie specifications can provide a specific 38 * implementation for this class based on their cookie handling 39 * rules. 40 * </p> 41 * 42 * @since 4.0 43 */ 44 @Contract(threading = ThreadingBehavior.STATELESS) 45 public interface CookieAttributeHandler { 46 47 /** 48 * Parse the given cookie attribute value and processChallenge the corresponding 49 * {@link org.apache.hc.client5.http.cookie.Cookie} property. 50 * 51 * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to be updated 52 * @param value cookie attribute value from the cookie response header 53 */ 54 void parse(SetCookie cookie, String value) 55 throws MalformedCookieException; 56 57 /** 58 * Peforms cookie validation for the given attribute value. 59 * 60 * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to validate 61 * @param origin the cookie source to validate against 62 * @throws MalformedCookieException if cookie validation fails for this attribute 63 */ 64 void validate(Cookie cookie, CookieOrigin origin) 65 throws MalformedCookieException; 66 67 /** 68 * Matches the given value (property of the destination host where request is being 69 * submitted) with the corresponding cookie attribute. 70 * 71 * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to match 72 * @param origin the cookie source to match against 73 * @return {@code true} if the match is successful; {@code false} otherwise 74 */ 75 boolean match(Cookie cookie, CookieOrigin origin); 76 77 }