001package org.apache.commons.jcs3.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 java.util.Properties;
023
024import org.apache.commons.jcs3.auxiliary.AuxiliaryCache;
025import org.apache.commons.jcs3.engine.control.CompositeCache;
026
027/**
028 * I need the interface so I can plug in mock managers for testing.
029 */
030public interface ICompositeCacheManager extends IShutdownObservable
031{
032    /**
033     * Gets the cache attribute of the CacheHub object
034     *
035     * @param cacheName
036     * @return CompositeCache
037     */
038    <K, V> CompositeCache<K, V>  getCache( String cacheName );
039
040    /**
041     * Gets the auxiliary cache attribute of the CacheHub object
042     *
043     * @param auxName
044     * @param cacheName
045     * @return AuxiliaryCache
046     */
047    <K, V> AuxiliaryCache<K, V>  getAuxiliaryCache( String auxName, String cacheName );
048
049    /**
050     * This is exposed so other manager can get access to the props.
051     * <p>
052     * @return the configurationProperties
053     */
054    Properties getConfigurationProperties();
055
056    /**
057     * Gets stats for debugging.
058     * <p>
059     * @return String
060     */
061    String getStats();
062}