01: /**
02: * Copyright (C) 2001-2005 France Telecom R&D
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: *
18: *
19: *
20: * Authors: S.Chassande-Barrioz.
21: * Created on 23 mars 2005
22: *
23: */package org.objectweb.speedo.usercache.api;
24:
25: import java.util.Collection;
26:
27: /**
28: * Defines a Manager of a set of user caches. It permits to initalizes user
29: * caches. Each user cache is identifier by an int value. The particular '-1'
30: * value represents no user cache.
31: *
32: * @author S.Chassande-Barrioz
33: */
34: public interface UserCacheManager {
35:
36: /**
37: * Retrives a user cache
38: * @param cacheId is the identifier of the asked user cache
39: * @return the user cache instance if found, null otherwise
40: */
41: UserCache getUserCache(int cacheId);
42:
43: /**
44: * Retrieves the name of the user cache which index is exactly composed
45: * by some field names.
46: * @param fieldNames is the collection of field names (String). The order of
47: * the collection is not important here.
48: * @return an user cache name if it has been found, null otherwise.
49: */
50: UserCache getUserCache(Collection fieldNames);
51:
52: /**
53: * Retrieves the list of user cache which has been initialized.
54: * @return a collection of UserCache instance
55: */
56: Collection getActiveUserCache();
57:
58: /**
59: * An entry of user cache has been unbound from the real cache.
60: * A typical implementation, undinds from active user caches, the entry.
61: * To do this the a persistent object which has
62: * been previously unexported.
63: *
64: * @param oid is the identifier of the persistent object to unbind
65: */
66: void userCacheEntryUnbound(Object oid);
67:
68: /**
69: * Initializes the user cache
70: * @param cacheName is the name of the user cache to initialize
71: * @return indicates if the cache has been initialized correctly
72: */
73: boolean activeUserCache(String cacheName);
74: }
|