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.time.Instant;
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 ensures that cookies with longer paths take precedence over
38 * cookies with shorter path. Among cookies with equal path length cookies with earlier
39 * creation time take precedence over cookies with later creation time
40 *
41 * @since 4.4
42 */
43 @Contract(threading = ThreadingBehavior.STATELESS)
44 public class CookiePriorityComparator implements Comparator<Cookie> {
45
46 /**
47 * Default instance of {@link CookiePriorityComparator}.
48 */
49 public static final CookiePriorityComparator INSTANCE = new CookiePriorityComparator();
50
51 private int getPathLength(final Cookie cookie) {
52 final String path = cookie.getPath();
53 return path != null ? path.length() : 1;
54 }
55
56 @Override
57 public int compare(final Cookie c1, final Cookie c2) {
58 final int l1 = getPathLength(c1);
59 final int l2 = getPathLength(c2);
60 final int result = l2 - l1;
61 if (result == 0) {
62 final Instant d1 = c1.getCreationInstant();
63 final Instant d2 = c2.getCreationInstant();
64 if (d1 != null && d2 != null) {
65 return d1.compareTo(d2);
66 }
67 }
68 return result;
69 }
70
71 }