View Javadoc

1   package org.apache.jcs.auxiliary;
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 org.apache.jcs.engine.behavior.ICacheType;
23  
24  /***
25   * AuxiliaryCacheManager
26   *
27   * FIXME: Should not need to extend ICacheType
28   *
29   */
30  public interface AuxiliaryCacheManager
31      extends ICacheType
32  {
33  
34      /***
35       * Return the appropriate auxiliary cache for this region.
36       *
37       * @param cacheName
38       * @return AuxiliaryCache
39       */
40      public AuxiliaryCache getCache( String cacheName );
41  
42      /***
43       * This allows the cache manager to be plugged into the auxiliary caches,
44       * rather then having them get it themselves. Cache maangers can be mocked
45       * out and the auxiliaries will be easier to test.
46       *
47       * @param cacheName
48       * @param cacheManager
49       * @return AuxiliaryCache
50       */
51      //public AuxiliaryCache getCache( String cacheName, ICompositeCacheManager
52      // cacheManager );
53  }