org.geomajas.service.CacheService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geomajas-api-experimental Show documentation

Geomajas server: Main - experimental api

There is a newer version: 1.18.5

Show newest version

/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2014 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */
package org.geomajas.service;

import org.geomajas.annotation.FutureApi;


/**
 * Service to register objects in a cache store. Objects are stored in different caches identified by a cache id.
 * The main purpose of this cache is to provide in-memory cache for java objects that need storage for a short time,
 * for example to save data between a Command and an Spring MVC service. There is no guarantee that cached objects 
 * are persisted during a server restart.
 * 
 * The default time to live for cached objects is {@value #DEFAULT_TTL} milliseconds.
 * 
 * @author Oliver May
 * @since 1.13.0
 */
@FutureApi
public interface CacheService {

	/**
	 * Default time to live.
	 */
	long DEFAULT_TTL = 86400 * 1000;
	
	/**
	 * Put an object in the cache, the default lifetime is {@value #DEFAULT_TTL} milliseconds.
	 * 
	 * @param cache the cache id
	 * @param key the key
	 * @param value the object
	 */
	void put(String cache, Object key, Object value);
	
	
	/**
	 * Put an object in the cache for a given limetolive.
	 * 
	 * @param cache the cache id
	 * @param key the key
	 * @param value the object
	 * @param timeToLive the minimum amount of time the item should stay in the cache om milliseconds
	 */
	void put(String cache, Object key, Object value, long timeToLive);
	
	/**
	 * Retrieve an object from a cache.
	 * 
	 * @param cache the cache id
	 * @param key the key
	 * @return the object
	 */
	Object get(String cache, Object key);
	
	/**
	 * Get the object with the given key and given type from the cache.
	 * 
	 * @param  the type of the result
	 * @param cache the cache id
	 * @param key the key
	 * @param type the type of the result
	 * @return the object with the requested type or null if the object doesn't exist or is of the wrong type
	 */
	 TYPE get(String cache, Object key, Class type);
	
	/**
	 * Remove an object from the cache.
	 * 
	 * @param cache the cache id
	 * @param key the key
	 */
	void remove(String cache, Object key);
	
	/**
	 * Remove all objects from the cache.
	 * 
	 * @param cache the cache id
	 */
	void clear(String cache);
	
	/**
	 * Cleanup the cache. This method will be called by the spring scheduler at a fixed rate to clean up the cache.
	 */
	void cleanUp();
	
}