Abstract:
The caching of heterogeneous bean sets has been improved from requiring each bean to have its own cache instance to caching the beans in a single cache. The beans can be identified by generating a unique identifier that is a combination of the bean&#39;s primary key and a self-reference identifier of the bean manager associated with that bean. The average size of a bean set associated with a bean manager can be specified such that the cache allocates memory for that set based on the average size. A callback interface can also be used to shift knowledge of a bean life cycle back to the bean manager. This description is not intended to be a complete description of, or limit the scope of, the invention. Other features, aspects, and objects of the invention can be obtained from a review of the specification, the figures, and the claims.

Description:
CLAIM OF PRIORITY  
       [0001]     This Application is a Continuation of U.S. patent application Ser. No. 10/340,067 entitled “System and Method for Heterogeneous Caching” filed Jan. 10, 2003 [Attorney Docket No. BEAS-01199US1], which claims priority of U.S. Provisional Application No. 60/349,577 entitled “System and Method for Heterogeneous Caching” filed Jan. 18, 2002 [Attorney Docket No. BEAS-01199US0]. 
     
    
     COPYRIGHT NOTICE  
       [0002]     A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document of the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.  
       CROSS REFERENCE TO RELATED PATENT DOCUMENTS  
       [0003]     The following co-pending U.S. patent documents are assigned to BEA Systems, Inc., the assignee of the present application, and these documents are hereby incorporated herein by reference:  
         [0004]     (A) U.S. Patent Application filed Jan. 10, 2003, application Ser. No. 10/340,301 to Seth White et al. and entitled, “System and Method for Read-Only Bean Caching”; and  
         [0005]     (B) U.S. Patent Application filed Jan. 10, 2003, application Ser. No. 10/340,023, to Seth White et al. and entitled, “System and Method for Optimistic Caching”.  
       FIELD OF THE INVENTION  
       [0006]     The invention relates to the caching of data and data objects.  
       BACKGROUND  
       [0007]     Many systems that use entity beans to hold instances of data for an application will generate a separate cache for each entity bean. It is then necessary to configure each of these caches. Utilizing separate caches can lead to problems with memory fragmentation. Further, users can set limits on the size of these individual caches such that the system may be unable to use all available memory. For example, one of the entity beans might be very busy and require a lot of memory, while other beans sit idle. If the caches are configured to accommodate the busiest bean, the unused beans will have large cache allocations that will not be utilized, thereby wasting memory.  
       BRIEF SUMMARY  
       [0008]     Systems and methods in accordance with embodiments of the present invention can utilize key identifiers to differentiate beans associated with different bean managers that might have a common primary key. In the system a bean, such as an entity bean, session bean, or Enterprise JavaBean (EJB), can be associated with data and have a primary key. A system can utilize a cache for caching the bean. A bean manager can be associated with the bean and the cache. The bean manager can have a self-reference identifier. A key identifier can be generated to identify the bean in the cache. The key identifier can be made up of a combination of the primary key and the self-reference identifier.  
         [0009]     Systems and methods in accordance with embodiments of the present invention can handle a first bean manager that is associated with beans of a first size on average, as well as a second bean manager that is associated with beans of a second size on average. A cache associated with the bean managers can cache both sizes of beans, allocating cache memory for each type of bean based on the average size of that type of bean.  
         [0010]     Other systems and methods in accordance with embodiments of the present inventions can shift all knowledge of the life cycle of a bean from the cache to the bean manager. A bean holding a data instance can be cached in a system cache. A bean manager associated with the bean can manage the life cycle of the bean. A callback interface associated with the cache can allow the cache to make callbacks on the bean manager that are related to the bean, such as callbacks involving notification events, for example.  
         [0011]     Other features, aspects and objects of the invention can be obtained from a review of the specification, the figures, and the claims. 
     
    
     BRIEF DESCRIPTION OF THE FIGURES  
       [0012]      FIG. 1  is a diagram of a system in accordance with one embodiment of the present invention.  
         [0013]      FIG. 2  is a diagram of a system in accordance with another embodiment of the present invention.  
         [0014]      FIG. 3  is a flowchart showing the steps of a method in accordance with the embodiment of the  FIG. 1 .  
     
    
     DETAILED DESCRIPTION  
       [0015]     Systems and methods in accordance with one embodiment of the present invention utilize a common cache to cache entity beans. One example allows a J2EE application to share a single runtime cache for multiple entity bean deployments. Allowing beans to share a cache can reduce the amount of allocated, but unused, system memory. Such a cache can be managed using a common resource algorithm. In one embodiment, a common resource algorithm allows a user to manage cache by allocating the whole cache to a single bean or by allocating cache based on the demand of individual beans. This approach can allow for a more intelligent management of memory.  
         [0016]     One problem to be overcome in introducing such a shared cache involved the need to uniquely identify beans in the cache. In a homogeneous set of beans, or a set of beans that all refer to a single data table, for example, the primary key of each bean can be used as an identifier. When a heterogeneous set is used, which may contain beans representing data in multiple data tables or databases, there can be beans in the cache that have a common primary key. In a simple example, the first item in table A and the first item in table B might each have a primary key value of “1” 
         [0017]     In order to allow for heterogeneous sets, but still utilize primary keys as identifiers, embodiments in accordance with the present invention can attach an additional object or identifier to the primary key that is put into the cache. Other approaches are possible, such as creating different caches for each data source so there will be no overlap of primary keys.  
         [0018]     For a given cache, beans can be included that are associated with different bean managers. As shown in  FIG. 1 , cache  100  is associated with bean manager  102  and bean manager  104 . The cache  100  manages the caching of the bean manager objects, which in turn manage the life cycle of the beans. Managing the life cycle can include tasks such as creating, removing, loading, and storing the beans. In  FIG. 1 , bean manager  102  is using cache  100  to cache its beans, such as bean  106 . There can be any number of bean managers associated with a cache. Cache  100  can hold the physical instances of each type of bean in its own internal data structure.  
         [0019]     In response to life cycle events, each bean manager can make service requests on the cache. For instance, a bean manager can inform the cache ahead of time if, for example, the bean manager creates a new bean. Before the bean manager can put something into the cache, however, the bean manager has to provide the cache with a key that uniquely identifies that bean in the cache. In one embodiment, the bean manager includes a self-reference in the key. For instance, if bean manager  102  has a bean  106  with primary key “1” and bean manager  104  has a bean  108  with primary key “1” bean manager  102  could cache the bean with a new primary key of “1102” and bean manager  104  could cache the bean with a new primary key of “1104” In this way, each bean retains its primary key value of “1” and maintains its unique identity by including a reference to the appropriate bean manager. The new key can be, for example, a Java class that encapsulates the primary key of the bean plus a new object that refers to the bean manger. The cache can use this new key to make callbacks on the appropriate bean managers.  
         [0020]     The ways in which resource limits can be specified for the cache are also an improvement over current systems. Presently, a user specifies a maximum number of beans in a cache. In accordance with one embodiment of the present invention, as shown in  FIG. 2 , a user can specify that beans have an average size for a particular bean manager. For example, the beans  204 ,  206  stored in cache  200  for bean manager  202  have the same average size, and the beans  210 ,  212 ,  214  for bean manager  208  have the same average size, which is larger than the average size for bean manager  202 . The cache  200  can then manage beans according to the relative average size for each bean manager. This allows the cache to manage beans more intelligently, as beans from different bean managers can have drastically different sizes and requirements. For instance, one bean might represent customer data and another bean might represent order information.  
         [0021]      FIG. 3  shows a method for caching a bean by key identifier. First, the primary key associated with a bean is determined  300 . Then, the self-reference identifier of the associated bean manager is read  302 . The primary key and self-reference identifier are then combined to form a unique key identifier  304 . The bean manager notifies the caches that a bean is to be cached that corresponds to that key identifier  306 . The bean is then loaded into the cache, which tracks the bean by the key identifier  308 .  
         [0022]     Many systems require a cache to have some knowledge of the life-cycle of a bean So the cache can call the life cycle methods on the beans themselves. This is difficult if the cache has to manage different types of beans. In accordance with one embodiment of the present invention, a cache can use a callback interface to make callbacks on a bean manager. A callback interface can be an event-driven method that points the cache in the proper direction for a bean without a bean having to have any knowledge of what exists outside the cache. Here, the bean manager can retain all bean-specific knowledge and information. The cache can simply inform the bean manager that something needs to be done, and does not have to worry about the life cycle of a bean.  
         [0023]     For example, a prior art system would call methods on a bean that are defined by the EJB specification before the cache could evict a bean, as the bean might be keeping a cache state or open resource to other things. In one embodiment in accordance with the present invention, the cache can simply give a notification event to the bean manager saying that a bean is about to be evicted and the bean manager can worry about whether something needs to be done before the bean is evicted.  
         [0024]     To configure application level cache, a user can make an entry in an application level deployment descriptor. A deployment descriptor is a file that indicates to an EJB server which classes make up the bean implementation and interfaces, as well as how EJBs interact if there is more than one EJB in a package. Certain elements can be used in an application level deployment descriptor to support heterogeneous entity bean caching. For example, a deployment descriptor, such as an XML file, can include the root element containing the name of the descriptor.  
         [0025]     Another element that can be included is an “ejb” element that is specific to the EJB modules of the application. An “entity cache” element can be used to define a named application level cache that caches entity ejb instances at runtime. Individual entity beans can specify the cache that they want to use through the name of the cache. There may be no restriction on the number of entity beans that reference an individual cache.  
         [0026]     Other elements can include, for example, an element specifying a unique name for an entity bean cache, the name being unique within an .ear (enterprise archive) file. An element specifying the maximum number of beans in the cache can be included, such as “max-beans-in-cache”, which specifies a limit on the size of an entity bean cache in terms of memory size, such as may be expressed in bytes or megabytes. An EJB container can attempt to estimate the amount of memory used by each entity bean in the cache, and limit the number of beans in the cache based on these estimates. Alternatively, a user can provide such estimates. An element can also be included that specifies the maximum cache size.  
         [0027]     Another element that can be used is a “read-timeout-seconds” or equivalent element. Such an element can specify the number of seconds between load (e.g., “ejbLoad”) calls on a Read-Only entity bean. If read-timeout-seconds is set to zero, ejbLoad may only be called when the bean is brought into the cache.  
         [0028]     A “concurrency-strategy” or similar element can be used to specify how a container should manage concurrent access to an entity bean. Concurrency-strategy can have, for example, values of “exclusive”, “database”, and “read-only”. “Exclusive” can refer to an exclusive locking scheme. “Database” can refer to a scheme in which a separate entity bean instance is allocated for each transaction, while the locking and caching is handled by the database. “Read-only” can be used to specify read-only entity beans.  
         [0029]     Certain other elements can be used, such as in a .jar (java archive) file, to configure an entity bean to use application-level cache. These elements can include, for example, entity-cache-name, estimated-bean-size, max-beans-in-cache, idle-timeout-seconds, read-timeout-seconds, and concurrency-strategy. The estimated-bean-size element can be used if a developer wants to override the container&#39;s estimate of the average bean size.  
         [0030]     The foregoing description of preferred embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Many modifications and variations will be apparent to one of ordinary skill in the relevant arts. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the claims and their equivalents.