View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.cache;
20  
21  /**
22   * A CacheManager provides and maintains the lifecycles of {@link Cache Cache} instances.
23   *
24   * <p>Shiro doesn't implement a full Cache mechanism itself, since that is outside the core competency of a
25   * Security framework.  Instead, this interface provides an abstraction (wrapper) API on top of an underlying
26   * cache framework's main Manager component (e.g. JCache, Ehcache, JCS, OSCache, JBossCache, TerraCotta, Coherence,
27   * GigaSpaces, etc, etc), allowing a Shiro user to configure any cache mechanism they choose.
28   *
29   * @since 0.9
30   */
31  public interface CacheManager {
32  
33      /**
34       * Acquires the cache with the specified <code>name</code>.  If a cache does not yet exist with that name, a new one
35       * will be created with that name and returned.
36       *
37       * @param name the name of the cache to acquire.
38       * @return the Cache with the given name
39       * @throws CacheException if there is an error acquiring the Cache instance.
40       */
41      public <K, V> Cache<K, V> getCache(String name) throws CacheException;
42  }