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.io.Serializable;
31  import java.util.Comparator;
32  
33  import org.apache.http.annotation.Contract;
34  import org.apache.http.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   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.IMMUTABLE)
45  public class CookieIdentityComparator implements Serializable, Comparator<Cookie> {
46  
47      private static final long serialVersionUID = 4466565437490631532L;
48  
49      @Override
50      public int compare(final Cookie c1, final Cookie c2) {
51          int res = c1.getName().compareTo(c2.getName());
52          if (res == 0) {
53              // do not differentiate empty and null domains
54              String d1 = c1.getDomain();
55              if (d1 == null) {
56                  d1 = "";
57              } else if (d1.indexOf('.') == -1) {
58                  d1 = d1 + ".local";
59              }
60              String d2 = c2.getDomain();
61              if (d2 == null) {
62                  d2 = "";
63              } else if (d2.indexOf('.') == -1) {
64                  d2 = d2 + ".local";
65              }
66              res = d1.compareToIgnoreCase(d2);
67          }
68          if (res == 0) {
69              String p1 = c1.getPath();
70              if (p1 == null) {
71                  p1 = "/";
72              }
73              String p2 = c2.getPath();
74              if (p2 == null) {
75                  p2 = "/";
76              }
77              res = p1.compareTo(p2);
78          }
79          return res;
80      }
81  
82  }