mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/BasicCookieStore.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 *
michael@0 4 * Licensed to the Apache Software Foundation (ASF) under one or more
michael@0 5 * contributor license agreements. See the NOTICE file distributed with
michael@0 6 * this work for additional information regarding copyright ownership.
michael@0 7 * The ASF licenses this file to You under the Apache License, Version 2.0
michael@0 8 * (the "License"); you may not use this file except in compliance with
michael@0 9 * the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing, software
michael@0 14 * distributed under the License is distributed on an "AS IS" BASIS,
michael@0 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0 16 * See the License for the specific language governing permissions and
michael@0 17 * limitations under the License.
michael@0 18 * ====================================================================
michael@0 19 *
michael@0 20 * This software consists of voluntary contributions made by many
michael@0 21 * individuals on behalf of the Apache Software Foundation. For more
michael@0 22 * information on the Apache Software Foundation, please see
michael@0 23 * <http://www.apache.org/>.
michael@0 24 *
michael@0 25 */
michael@0 26
michael@0 27 package ch.boye.httpclientandroidlib.impl.client;
michael@0 28
michael@0 29 import java.io.Serializable;
michael@0 30 import java.util.*;
michael@0 31
michael@0 32 import ch.boye.httpclientandroidlib.annotation.GuardedBy;
michael@0 33 import ch.boye.httpclientandroidlib.annotation.ThreadSafe;
michael@0 34
michael@0 35 import ch.boye.httpclientandroidlib.client.CookieStore;
michael@0 36 import ch.boye.httpclientandroidlib.cookie.Cookie;
michael@0 37 import ch.boye.httpclientandroidlib.cookie.CookieIdentityComparator;
michael@0 38
michael@0 39 /**
michael@0 40 * Default implementation of {@link CookieStore}
michael@0 41 *
michael@0 42 *
michael@0 43 * @since 4.0
michael@0 44 */
michael@0 45 @ThreadSafe
michael@0 46 public class BasicCookieStore implements CookieStore, Serializable {
michael@0 47
michael@0 48 private static final long serialVersionUID = -7581093305228232025L;
michael@0 49
michael@0 50 @GuardedBy("this")
michael@0 51 private final TreeSet<Cookie> cookies;
michael@0 52
michael@0 53 public BasicCookieStore() {
michael@0 54 super();
michael@0 55 this.cookies = new TreeSet<Cookie>(new CookieIdentityComparator());
michael@0 56 }
michael@0 57
michael@0 58 /**
michael@0 59 * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies.
michael@0 60 * If the given cookie has already expired it will not be added, but existing
michael@0 61 * values will still be removed.
michael@0 62 *
michael@0 63 * @param cookie the {@link Cookie cookie} to be added
michael@0 64 *
michael@0 65 * @see #addCookies(Cookie[])
michael@0 66 *
michael@0 67 */
michael@0 68 public synchronized void addCookie(Cookie cookie) {
michael@0 69 if (cookie != null) {
michael@0 70 // first remove any old cookie that is equivalent
michael@0 71 cookies.remove(cookie);
michael@0 72 if (!cookie.isExpired(new Date())) {
michael@0 73 cookies.add(cookie);
michael@0 74 }
michael@0 75 }
michael@0 76 }
michael@0 77
michael@0 78 /**
michael@0 79 * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and
michael@0 80 * in the given array order. If any of the given cookies has already expired it will
michael@0 81 * not be added, but existing values will still be removed.
michael@0 82 *
michael@0 83 * @param cookies the {@link Cookie cookies} to be added
michael@0 84 *
michael@0 85 * @see #addCookie(Cookie)
michael@0 86 *
michael@0 87 */
michael@0 88 public synchronized void addCookies(Cookie[] cookies) {
michael@0 89 if (cookies != null) {
michael@0 90 for (Cookie cooky : cookies) {
michael@0 91 this.addCookie(cooky);
michael@0 92 }
michael@0 93 }
michael@0 94 }
michael@0 95
michael@0 96 /**
michael@0 97 * Returns an immutable array of {@link Cookie cookies} that this HTTP
michael@0 98 * state currently contains.
michael@0 99 *
michael@0 100 * @return an array of {@link Cookie cookies}.
michael@0 101 */
michael@0 102 public synchronized List<Cookie> getCookies() {
michael@0 103 //create defensive copy so it won't be concurrently modified
michael@0 104 return new ArrayList<Cookie>(cookies);
michael@0 105 }
michael@0 106
michael@0 107 /**
michael@0 108 * Removes all of {@link Cookie cookies} in this HTTP state
michael@0 109 * that have expired by the specified {@link java.util.Date date}.
michael@0 110 *
michael@0 111 * @return true if any cookies were purged.
michael@0 112 *
michael@0 113 * @see Cookie#isExpired(Date)
michael@0 114 */
michael@0 115 public synchronized boolean clearExpired(final Date date) {
michael@0 116 if (date == null) {
michael@0 117 return false;
michael@0 118 }
michael@0 119 boolean removed = false;
michael@0 120 for (Iterator<Cookie> it = cookies.iterator(); it.hasNext();) {
michael@0 121 if (it.next().isExpired(date)) {
michael@0 122 it.remove();
michael@0 123 removed = true;
michael@0 124 }
michael@0 125 }
michael@0 126 return removed;
michael@0 127 }
michael@0 128
michael@0 129 /**
michael@0 130 * Clears all cookies.
michael@0 131 */
michael@0 132 public synchronized void clear() {
michael@0 133 cookies.clear();
michael@0 134 }
michael@0 135
michael@0 136 @Override
michael@0 137 public synchronized String toString() {
michael@0 138 return cookies.toString();
michael@0 139 }
michael@0 140
michael@0 141 }

mercurial