001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.cookie;
029
030import java.util.Comparator;
031import java.util.Date;
032
033import org.apache.http.annotation.Contract;
034import org.apache.http.annotation.ThreadingBehavior;
035import org.apache.http.impl.cookie.BasicClientCookie;
036
037/**
038 * This cookie comparator ensures that cookies with longer paths take precedence over
039 * cookies with shorter path. Among cookies with equal path length cookies with ealier
040 * creation time take precedence over cookies with later creation time
041 *
042 * @since 4.4
043 */
044@Contract(threading = ThreadingBehavior.IMMUTABLE)
045public class CookiePriorityComparator implements Comparator<Cookie> {
046
047    public static final CookiePriorityComparator INSTANCE = new CookiePriorityComparator();
048
049    private int getPathLength(final Cookie cookie) {
050        final String path = cookie.getPath();
051        return path != null ? path.length() : 1;
052    }
053
054    @Override
055    public int compare(final Cookie c1, final Cookie c2) {
056        final int l1 = getPathLength(c1);
057        final int l2 = getPathLength(c2);
058        //TODO: update this class once Cookie interface has been expended with #getCreationTime method
059        final int result = l2 - l1;
060        if (result == 0 && c1 instanceof BasicClientCookie && c2 instanceof BasicClientCookie) {
061            final Date d1 = ((BasicClientCookie) c1).getCreationDate();
062            final Date d2 = ((BasicClientCookie) c2).getCreationDate();
063            if (d1 != null && d2 != null) {
064                return (int) (d1.getTime() - d2.getTime());
065            }
066        }
067        return result;
068    }
069
070}