UserCacheManager


1   /**
2    * Copyright (C) 2001-2005 France Telecom R&D
3    *
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2 of the License, or (at your option) any later version.
8    *
9    * 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   */
24  package org.objectweb.speedo.usercache.api;
25  
26  import java.util.Collection  ;
27  
28  /**
29   * Defines a Manager of a set of user caches. It permits to initalizes user 
30   * caches. Each user cache is identifier by an int value. The particular '-1' 
31   * value represents no user cache. 
32   *
33   * @author S.Chassande-Barrioz
34   */
35  public interface UserCacheManager {
36  
37      /**
38       * Retrives a user cache
39       * @param cacheId is the identifier of the asked user cache
40       * @return the user cache instance if found, null otherwise
41       */
42      UserCache getUserCache(int cacheId);
43      
44      /**
45       * Retrieves the name of the user cache which index is exactly composed
46       * by some field names.
47       * @param fieldNames is the collection of field names (String). The order of
48       * the collection is not important here.
49       * @return an user cache name if it has been found, null otherwise.
50       */
51      UserCache getUserCache(Collection   fieldNames);
52      
53      /**
54       * Retrieves the list of user cache which has been initialized.
55       * @return a collection of UserCache instance
56       */
57      Collection   getActiveUserCache();
58      
59      /**
60       * An entry of user cache has been unbound from the real cache.
61       * A typical implementation, undinds from active user caches, the entry.
62       * To do this the a persistent object which has
63       * been previously unexported.
64       * 
65       * @param oid is the identifier of the persistent object to unbind
66       */
67      void userCacheEntryUnbound(Object   oid);
68      
69      /**
70       * Initializes the user cache
71       * @param cacheName is the name of the user cache to initialize
72       * @return indicates if the cache has been initialized correctly
73       */
74      boolean activeUserCache(String   cacheName);
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags