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