View Javadoc

1   package org.apache.jcs.auxiliary.lateral.behavior;
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 java.io.IOException;
23  import java.util.Map;
24  
25  import org.apache.jcs.auxiliary.AuxiliaryCacheManager;
26  
27  /***
28   * This helps ensure some common behvior among LateraLCacheManagers for things
29   * such as montiors.
30   * <p>
31   * @author Aaron Smuts
32   */
33  public interface ILateralCacheManager
34      extends AuxiliaryCacheManager
35  {
36      /***
37       * This is a temporary solution that allos the monitor to get the instances
38       * of a manager.
39       * @return
40       */
41      public abstract Map getInstances();
42  
43      /***
44       * This is a temporary solution that allos the monitor to get caches from an
45       * instance of a manager.
46       * @return
47       */
48      public abstract Map getCaches();
49  
50      /***
51       * The restore calls thsi on the manger if a cache if found to be in error.
52       * @return Object is the service if it can be fixed.
53       * @throws IOException
54       *             if the service cannot be fixed.
55       */
56      public abstract Object fixService()
57          throws IOException;
58  
59      /***
60       * Sets the corected service. The restore process will call this if it gets
61       * a good service back from fixService.
62       * @param lateralService
63       * @param lateralWatch
64       */
65      public void fixCaches( ILateralCacheService lateralService, ILateralCacheObserver lateralWatch );
66  
67  }