001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.cache;
020
021/**
022 * A CacheManager provides and maintains the lifecycles of {@link Cache Cache} instances.
023 *
024 * <p>Shiro doesn't implement a full Cache mechanism itself, since that is outside the core competency of a
025 * Security framework.  Instead, this interface provides an abstraction (wrapper) API on top of an underlying
026 * cache framework's main Manager component (e.g. JCache, Ehcache, JCS, OSCache, JBossCache, TerraCotta, Coherence,
027 * GigaSpaces, etc, etc), allowing a Shiro user to configure any cache mechanism they choose.
028 *
029 * @since 0.9
030 */
031public interface CacheManager {
032
033    /**
034     * Acquires the cache with the specified <code>name</code>.  If a cache does not yet exist with that name, a new one
035     * will be created with that name and returned.
036     *
037     * @param name the name of the cache to acquire.
038     * @return the Cache with the given name
039     * @throws CacheException if there is an error acquiring the Cache instance.
040     */
041    public <K, V> Cache<K, V> getCache(String name) throws CacheException;
042}