01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/memory/tags/sakai_2-4-1/memory-api/api/src/java/org/sakaiproject/memory/api/MultiRefCache.java $
03: * $Id: MultiRefCache.java 7073 2006-03-27 20:56:40Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.memory.api;
21:
22: import java.util.Collection;
23:
24: /**
25: * <p>
26: * MultiRefCache is a cache that holds objects and a set of references that the cached entry are dependent on - if any change, the entry is invalidated.
27: * </p>
28: */
29: public interface MultiRefCache extends Cache {
30: /**
31: * Cache an object
32: *
33: * @param key
34: * The key with which to find the object.
35: * @param payload
36: * The object to cache.
37: * @param duration
38: * The time to cache the object (seconds).
39: * @param ref
40: * One entity reference that, if changed, will invalidate this entry.
41: * @param azgIds
42: * AuthzGroup ids that, if the changed, will invalidate this entry.
43: */
44: void put(Object key, Object payload, int duration, String ref,
45: Collection azgIds);
46: }
|