Added CookieStore interface

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@558123 13f79535-47bb-0310-9956-ffa450edef68

module-client/src/main/java/org/apache/http/client/AuthState.java

@@ -39,7 +39,7 @@
  * This class provides detailed information about the state of the
  * authentication process.
  * 
- * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
+ * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
  *
  * @since 4.0
  */

module-client/src/main/java/org/apache/http/client/CircularRedirectException.java

@@ -33,7 +33,7 @@
 /**
  * Signals a circular redirect
  * 
- * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
+ * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
  * 
  * @since 4.0
  */

module-client/src/main/java/org/apache/http/client/CookieStore.java

@@ -0,0 +1,75 @@
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF licenses this file to You under the Apache License, Version 2.0
+ *  (the "License"); you may not use this file except in compliance with
+ *  the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.http.client;
+
+import java.util.Date;
+
+import org.apache.http.cookie.Cookie;
+
+/**
+ * Abstract cookie store.
+ * 
+ * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * 
+ * @since 4.0
+ */
+public interface CookieStore {
+
+    /**
+     * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies.
+     * If the given cookie has already expired it will not be added, but existing 
+     * values will still be removed.
+     * 
+     * @param cookie the {@link Cookie cookie} to be added
+     */
+    void addCookie(Cookie cookie);
+
+    /**
+     * Returns all cookies contained in this store.
+     * 
+     * @return all cookies
+     */
+    Cookie[] getCookies();
+
+    /**
+     * Removes all of {@link Cookie cookies} in this store that have expired by 
+     * the specified {@link java.util.Date date}. 
+     * 
+     * @return true if any cookies were purged.
+     */
+    boolean clearExpired(Date date);
+
+    /**
+     * Clears all cookies.
+     */
+    void clear();
+    
+}

module-client/src/main/java/org/apache/http/client/HttpState.java

@@ -60,7 +60,7 @@
  * @version $Revision$ $Date$
  * 
  */
-public class HttpState {
+public class HttpState implements CookieStore {
 
     // ----------------------------------------------------- Instance Variables
 
@@ -153,12 +153,11 @@ public synchronized Cookie[] getCookies() {
      * 
      * @see Cookie#isExpired(Date)
      */
-    public synchronized boolean purgeExpiredCookies() {
+    public synchronized boolean clearExpired(Date date) {
         boolean removed = false;
-        Date now = new Date();
         Iterator it = cookies.iterator();
         while (it.hasNext()) {
-            if (((Cookie) (it.next())).isExpired(now)) {
+            if (((Cookie) (it.next())).isExpired(date)) {
                 it.remove();
                 removed = true;
             }
@@ -166,6 +165,8 @@ public synchronized boolean purgeExpiredCookies() {
         return removed;
     }
 
+    
+    
     /** 
      * Sets the {@link Credentials credentials} for the given authentication 
      * scope. Any previous credentials for the given scope will be overwritten.