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.ICompositeCacheManager;
23  
24  /***
25   * All auxiliary caches must have a factory that the cache configurator can use
26   * to create instances.
27   *
28   */
29  public interface AuxiliaryCacheFactory
30  {
31  
32      /***
33       *
34       * @param attr
35       *
36       * @param cacheMgr
37       *            This allows auxiliaries to reference the manager without
38       *            assuming that it is a singleton. This will allow JCS to be a
39       *            nonsingleton. Also, it makes it easier to test.
40       *
41       * @return AuxiliaryCache
42       */
43      public AuxiliaryCache createCache( AuxiliaryCacheAttributes attr, ICompositeCacheManager cacheMgr );
44  
45      /***
46       * Sets the name attribute of the AuxiliaryCacheFactory object
47       *
48       * @param s
49       *            The new name value
50       */
51      public void setName( String s );
52  
53      /***
54       * Gets the name attribute of the AuxiliaryCacheFactory object
55       *
56       * @return The name value
57       */
58      public String getName();
59  
60  }