| package org.apache.fulcrum.cache; |
| |
| /* |
| * 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. |
| */ |
| |
| import java.io.IOException; |
| import java.util.List; |
| |
| /** |
| * GlobalCacheService interface. |
| * |
| * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> |
| * @author <a href="mailto:peter@courefreshableCachedObjectux.biz">Peter CourefreshableCachedObjectux</a> |
| * @version $Id$ |
| */ |
| public interface GlobalCacheService |
| { |
| /** Avalon role - used to id the component within the manager */ |
| String ROLE = GlobalCacheService.class.getName(); |
| |
| /** |
| * Gets a cached object given its id (a String). |
| * |
| * @param <T> type of object to return |
| * @param objectId |
| * The String id for the object. |
| * @return A CachedObject. |
| * @throws ObjectExpiredException |
| * if the object has expired in the cache. |
| */ |
| <T> CachedObject<T> getObject(String objectId) throws ObjectExpiredException; |
| |
| /** |
| * Adds an object to the cache. |
| * |
| * @param <T> type of object to add |
| * @param objectId |
| * The String id for the object. |
| * @param object |
| * The object to add to the cache. |
| */ |
| <T> void addObject(String objectId, CachedObject<T> object); |
| |
| /** |
| * Removes an object from the cache. |
| * |
| * @param objectId |
| * The String id for the object. |
| */ |
| void removeObject(String objectId); |
| |
| /** |
| * Returns a copy of keys to objects in the cache as a list. |
| * |
| * Note that keys to expired objects are not returned. |
| * |
| * @return A List of <code>String</code>'s representing the keys to |
| * objects in the cache. |
| */ |
| List<String> getKeys(); |
| |
| /** |
| * Returns a copy of the non-expired CachedObjects in the cache as a list. |
| * |
| * @return A List of <code>CachedObject</code> objects held in the cache |
| */ |
| List<CachedObject<?>> getCachedObjects(); |
| |
| /** |
| * Returns the current size of the cache. |
| * |
| * @return int representing current cache size in number of bytes |
| * @throws IOException if unable to return cache size |
| */ |
| int getCacheSize() throws IOException; |
| |
| /** |
| * Returns the number of objects in the cache. |
| * |
| * @return int The current number of objects in the cache. |
| */ |
| int getNumberOfObjects(); |
| |
| /** |
| * Flush the cache of all objects. |
| */ |
| void flushCache(); |
| } |