/*
 * ====================================================================
 * 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.hc.client5.http.cookie;

import java.time.Instant;
import java.util.Date;
import java.util.List;

/**
 * This interface represents an abstract store for {@link Cookie}
 * objects.
 *
 * @since 4.0
 */
public interface CookieStore {

    /**
     * Adds an {@link 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
     */
    List<Cookie> getCookies();

    /**
     * Removes all of {@link Cookie}s in this store that have expired by
     * the specified {@link Date}.
     *
     * @return true if any cookies were purged.
     * @deprecated  Use {@link #clearExpired(Instant)}
     */
    @Deprecated
    boolean clearExpired(Date date);

    /**
     * Removes all of {@link Cookie}s in this store that have expired by
     * the specified {@link Instant}.
     *
     * @return true if any cookies were purged.
     */
    @SuppressWarnings("deprecation")
    default boolean clearExpired(Instant date) {
        return clearExpired(date != null ? new Date(date.toEpochMilli()) : null);
    }

    /**
     * Clears all cookies.
     */
    void clear();

}
