/**
 * Copyright (C) 2012-2013 Selventa, Inc.
 *
 * This file is part of the OpenBEL Framework.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The OpenBEL Framework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the OpenBEL Framework. If not, see <http://www.gnu.org/licenses/>.
 *
 * Additional Terms under LGPL v3:
 *
 * This license does not authorize you and you are prohibited from using the
 * name, trademarks, service marks, logos or similar indicia of Selventa, Inc.,
 * or, in the discretion of other licensors or authors of the program, the
 * name, trademarks, service marks, logos or similar indicia of such authors or
 * licensors, in any marketing or advertising materials relating to your
 * distribution of the program or any covered product. This restriction does
 * not waive or limit your obligation to keep intact all copyright notices set
 * forth in the program as delivered to you.
 *
 * If you distribute the program in whole or in part, or any modified version
 * of the program, and you assume contractual liability to the recipient with
 * respect to the program or modified version, then you will indemnify the
 * authors and licensors of the program for any liabilities that these
 * contractual assumptions directly impose on those licensors and authors.
 */
package org.openbel.framework.core.cache;

import java.io.IOException;

import org.openbel.framework.common.cfg.SystemConfiguration;
import org.openbel.framework.common.index.Index;
import org.openbel.framework.core.df.cache.ResourceType;

/**
 * CacheManagerService defines a service for managing the framework cache.
 *
 * @author Anthony Bargnesi {@code <abargnesi@selventa.com>}
 */
public interface CacheManagerService {

    /**
     * Purges all cached files from the cache directory located at
     * {@link SystemConfiguration#getCacheDirectory()}.
     * <p>
     * :-(*)
     * </p>
     * @throws IOException Thrown if IO errors occurred purging the cache
     */
    public void purgeResources() throws IOException;

    /**
     * Updates a single resource in the cache identified by it's {@link String}
     * <tt>location</tt>.  The <tt>type</tt> {@link ResourceType} must also be
     * provided in order to identify where it should live in the cache.
     *
     * @param type {@link ResourceType}, the resource type
     * @param location {@link String}, the resource location
     */
    public void updateResourceInCache(ResourceType type, String location);

    /**
     * Updates all resources identified in the resource index.
     *
     * @param index {@link Index}, the resource index to update resources from
     */
    public void updateResourceIndexInCache(Index index);
}