001package org.apache.commons.jcs.engine.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.commons.jcs.auxiliary.AuxiliaryCache;
023import org.apache.commons.jcs.engine.control.CompositeCache;
024
025import java.util.Properties;
026
027/**
028 * I need the interface so I can plug in mock managers for testing.
029 *
030 * @author Aaron Smuts
031 */
032public interface ICompositeCacheManager extends IShutdownObservable
033{
034    /**
035     * Gets the cache attribute of the CacheHub object
036     *
037     * @param cacheName
038     * @return CompositeCache
039     */
040    <K, V> CompositeCache<K, V>  getCache( String cacheName );
041
042    /**
043     * Gets the auxiliary cache attribute of the CacheHub object
044     *
045     * @param auxName
046     * @param cacheName
047     * @return AuxiliaryCache
048     */
049    <K, V> AuxiliaryCache<K, V>  getAuxiliaryCache( String auxName, String cacheName );
050
051    /**
052     * This is exposed so other manager can get access to the props.
053     * <p>
054     * @return the configurationProperties
055     */
056    Properties getConfigurationProperties();
057
058    /**
059     * Gets stats for debugging.
060     * <p>
061     * @return String
062     */
063    String getStats();
064}