org.bonitasoft.engine.cache.CacheService Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2011-2013 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library 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
 * version 2.1 of the License.
 * This library 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 this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 */
package org.bonitasoft.engine.cache;

import java.io.Serializable;
import java.util.List;

/**
 * Service that helps you to cache objects
 * Objects must be stored in a specific cache and this cache must exists
 * 
 * @author Baptiste Mesta
 * @author Matthieu Chaffotte
 * @since 6.0
 */
public interface CacheService {

    /**
     * Store an object in the cache.
     * 
     * @param cacheName
     *            The name of the cache in which the object must be stored
     * @param key
     *            The key that will allow to retrieve the object
     * @param value
     *            The object to store
     * @throws CacheException
     *             Error thrown if has exceptions during the cache store.
     */
    void store(String cacheName, Serializable key, Object value) throws CacheException;

    /**
     * Remove the element according to the cache name and the key
     * 
     * @param cacheName
     *            The name of the cache where the object must be stored
     * @param key
     *            The key that will allow to retrieve the object
     * @return
     *         true if an element was removed
     * @throws CacheException
     *             Error thrown if has exceptions during the cache remove.
     */
    boolean remove(String cacheName, Object key) throws CacheException;

    /**
     * Get a cached object.
     * 
     * @param cacheName
     *            The name of the cache on which to get the object
     * @param key
     *            The key that is used to store the object
     * @return the cached object, or null if it doesn't exists
     * @throws CacheException
     *             Error thrown if has exceptions during the cache object get.
     */
    Object get(String cacheName, Object key) throws CacheException;

    /**
     * Get list of keys on a cache.
     * 
     * @param cacheName
     *            The name of the cache on which to get the key list
     * @return the list of keys on the cache, or null if no keys exist
     * @throws CacheException
     */
    List getKeys(String cacheName) throws CacheException;

    /**
     * Clear the cache named by cacheName
     * 
     * @param cacheName
     *            The name of the cache to clear
     * @return
     * @throws CacheException
     *             Error thrown if has exceptions during the cache clear.
     */
    boolean clear(String cacheName) throws CacheException;

    /**
     * Clear all cache of the service
     * 
     * @throws CacheException
     *             Error thrown if has exceptions during the cache clear.
     */
    void clearAll() throws CacheException;

    /**
     * Return the size of the cache with cacheName.
     * 
     * @param cacheName
     *            The name of cache
     * @return the size of the named cache
     * @throws CacheException
     *             if no cache is found with that name.
     */
    int getCacheSize(String cacheName) throws CacheException;

    /**
     * Get the names of all the caches
     * 
     * @return a list of caches names
     */
    List getCachesNames();

}