1 package org.apache.commons.jcs.auxiliary;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.commons.jcs.engine.behavior.ICompositeCacheManager;
23 import org.apache.commons.jcs.engine.behavior.IElementSerializer;
24 import org.apache.commons.jcs.engine.logging.behavior.ICacheEventLogger;
25
26 /**
27 * All auxiliary caches must have a factory that the cache configurator can use to create instances.
28 */
29 public interface AuxiliaryCacheFactory
30 {
31 /**
32 * Creates an auxiliary using the supplied attributes. Adds it to the composite cache manager.
33 *
34 * @param attr
35 * @param cacheMgr This allows auxiliaries to reference the manager without assuming that it is
36 * a singleton. This will allow JCS to be a non-singleton. Also, it makes it easier to
37 * test.
38 * @param cacheEventLogger
39 * @param elementSerializer
40 * @return AuxiliaryCache
41 * @throws Exception if cache instance could not be created
42 */
43 <K, V> AuxiliaryCache<K, V> createCache(
44 AuxiliaryCacheAttributes attr, ICompositeCacheManager cacheMgr,
45 ICacheEventLogger cacheEventLogger, IElementSerializer elementSerializer )
46 throws Exception;
47
48 /**
49 * Initialize this factory
50 */
51 void initialize();
52
53 /**
54 * Dispose of this factory, clean up shared resources
55 */
56 void dispose();
57
58 /**
59 * Sets the name attribute of the AuxiliaryCacheFactory object
60 *
61 * @param s The new name value
62 */
63 void setName( String s );
64
65 /**
66 * Gets the name attribute of the AuxiliaryCacheFactory object
67 *
68 * @return The name value
69 */
70 String getName();
71 }