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
28 package org.apache.hc.client5.http.cookie;
29
30 import java.io.Serializable;
31 import java.util.Comparator;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35
36 /**
37 * This cookie comparator can be used to compare identity of cookies.
38 * <p>
39 * Cookies are considered identical if their names are equal and
40 * their domain attributes match ignoring case.
41 * </p>
42 *
43 * @since 4.0
44 */
45 @Contract(threading = ThreadingBehavior.STATELESS)
46 public class CookieIdentityComparator implements Serializable, Comparator<Cookie> {
47
48 /**
49 * Singleton instance.
50 *
51 * @since 5.2
52 */
53 public static final CookieIdentityComparator INSTANCE = new CookieIdentityComparator();
54
55 private static final long serialVersionUID = 4466565437490631532L;
56
57 @Override
58 public int compare(final Cookie c1, final Cookie c2) {
59 int res = c1.getName().compareTo(c2.getName());
60 if (res == 0) {
61 // do not differentiate empty and null domains
62 String d1 = c1.getDomain();
63 if (d1 == null) {
64 d1 = "";
65 }
66 String d2 = c2.getDomain();
67 if (d2 == null) {
68 d2 = "";
69 }
70 res = d1.compareToIgnoreCase(d2);
71 }
72 if (res == 0) {
73 String p1 = c1.getPath();
74 if (p1 == null) {
75 p1 = "/";
76 }
77 String p2 = c2.getPath();
78 if (p2 == null) {
79 p2 = "/";
80 }
81 res = p1.compareTo(p2);
82 }
83 return res;
84 }
85
86 }