View Javadoc
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.http.cookie;
29  
30  import java.util.Comparator;
31  import java.util.Date;
32  
33  import org.apache.http.annotation.Contract;
34  import org.apache.http.annotation.ThreadingBehavior;
35  import org.apache.http.impl.cookie.BasicClientCookie;
36  
37  /**
38   * This cookie comparator ensures that cookies with longer paths take precedence over
39   * cookies with shorter path. Among cookies with equal path length cookies with ealier
40   * creation time take precedence over cookies with later creation time
41   *
42   * @since 4.4
43   */
44  @Contract(threading = ThreadingBehavior.IMMUTABLE)
45  public class CookiePriorityComparator implements Comparator<Cookie> {
46  
47      public static final CookiePriorityComparator INSTANCE = new CookiePriorityComparator();
48  
49      private int getPathLength(final Cookie cookie) {
50          final String path = cookie.getPath();
51          return path != null ? path.length() : 1;
52      }
53  
54      @Override
55      public int compare(final Cookie c1, final Cookie c2) {
56          final int l1 = getPathLength(c1);
57          final int l2 = getPathLength(c2);
58          //TODO: update this class once Cookie interface has been expended with #getCreationTime method
59          final int result = l2 - l1;
60          if (result == 0 && c1 instanceof BasicClientCookie && c2 instanceof BasicClientCookie) {
61              final Date d1 = ((BasicClientCookie) c1).getCreationDate();
62              final Date d2 = ((BasicClientCookie) c2).getCreationDate();
63              if (d1 != null && d2 != null) {
64                  return (int) (d1.getTime() - d2.getTime());
65              }
66          }
67          return result;
68      }
69  
70  }