1 package org.apache.commons.jcs.engine.behavior;
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.auxiliary.AuxiliaryCache;
23 import org.apache.commons.jcs.engine.control.CompositeCache;
24
25 import java.util.Properties;
26
27 /**
28 * I need the interface so I can plug in mock managers for testing.
29 *
30 * @author Aaron Smuts
31 */
32 public interface ICompositeCacheManager extends IShutdownObservable
33 {
34 /**
35 * Gets the cache attribute of the CacheHub object
36 *
37 * @param cacheName
38 * @return CompositeCache
39 */
40 <K, V> CompositeCache<K, V> getCache( String cacheName );
41
42 /**
43 * Gets the auxiliary cache attribute of the CacheHub object
44 *
45 * @param auxName
46 * @param cacheName
47 * @return AuxiliaryCache
48 */
49 <K, V> AuxiliaryCache<K, V> getAuxiliaryCache( String auxName, String cacheName );
50
51 /**
52 * This is exposed so other manager can get access to the props.
53 * <p>
54 * @return the configurationProperties
55 */
56 Properties getConfigurationProperties();
57
58 /**
59 * Gets stats for debugging.
60 * <p>
61 * @return String
62 */
63 String getStats();
64 }