01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19: package org.apache.openjpa.datacache;
20:
21: import org.apache.openjpa.conf.OpenJPAConfiguration;
22: import org.apache.openjpa.lib.conf.ObjectValue;
23:
24: /**
25: * Manages the system's data and query caches. You can
26: * retrieve the data cache manager from the {@link OpenJPAConfiguration}.
27: *
28: * @author Abe White
29: * @author Patrick Linskey
30: */
31: public interface DataCacheManager {
32:
33: /**
34: * Initialize the manager, supplying the cache configuration.
35: */
36: public void initialize(OpenJPAConfiguration conf,
37: ObjectValue dataCache, ObjectValue queryCache);
38:
39: /**
40: * Return the system-wide data cache, or null if caching is not enabled.
41: */
42: public DataCache getSystemDataCache();
43:
44: /**
45: * Return the named data cache, or null if it does not exist.
46: */
47: public DataCache getDataCache(String name);
48:
49: /**
50: * Return the named data cache. If the given name is null, the default
51: * data cache is returned.
52: *
53: * @param create if true, the cache will be created if it does
54: * not already exist
55: */
56: public DataCache getDataCache(String name, boolean create);
57:
58: /**
59: * Return the system query cache, or null if not configured.
60: */
61: public QueryCache getSystemQueryCache();
62:
63: /**
64: * Return the PCData generator if configured.
65: */
66: public DataCachePCDataGenerator getPCDataGenerator();
67:
68: /**
69: * Return the runnable which schedules evictions.
70: */
71: public DataCacheScheduler getDataCacheScheduler();
72:
73: /**
74: * Close all caches.
75: */
76: public void close();
77: }
|