• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/CookiePathComparator.java $
3  * $Revision: 653041 $
4  * $Date: 2008-05-03 03:39:28 -0700 (Sat, 03 May 2008) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http.cookie;
33 
34 import java.io.Serializable;
35 import java.util.Comparator;
36 
37 /**
38  * This cookie comparator ensures that multiple cookies satisfying
39  * a common criteria are ordered in the <tt>Cookie</tt> header such
40  * that those with more specific Path attributes precede those with
41  * less specific.
42  *
43  * <p>
44  * This comparator assumes that Path attributes of two cookies
45  * path-match a commmon request-URI. Otherwise, the result of the
46  * comparison is undefined.
47  * </p>
48  *
49  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
50  */
51 public class CookiePathComparator implements Serializable, Comparator<Cookie> {
52 
53     private static final long serialVersionUID = 7523645369616405818L;
54 
normalizePath(final Cookie cookie)55     private String normalizePath(final Cookie cookie) {
56         String path = cookie.getPath();
57         if (path == null) {
58             path = "/";
59         }
60         if (!path.endsWith("/")) {
61             path = path + '/';
62         }
63         return path;
64     }
65 
compare(final Cookie c1, final Cookie c2)66     public int compare(final Cookie c1, final Cookie c2) {
67         String path1 = normalizePath(c1);
68         String path2 = normalizePath(c2);
69         if (path1.equals(path2)) {
70             return 0;
71         } else if (path1.startsWith(path2)) {
72             return -1;
73         } else if (path2.startsWith(path1)) {
74             return 1;
75         } else {
76             // Does not really matter
77             return 0;
78         }
79     }
80 
81 }
82