View Javadoc

1   /**
2    *  Copyright 2003-2006 Greg Luck
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.ehcache.distribution;
18  
19  import net.sf.ehcache.CacheException;
20  
21  import java.util.List;
22  
23  /**
24   * A listener for updates, which controls remote cache peers.
25   * @author Greg Luck
26   * @version $Id: CacheManagerPeerListener.java 52 2006-04-24 14:50:03Z gregluck $
27   */
28  public interface CacheManagerPeerListener {
29  
30  
31      /**
32       * Call to start the listeners and do any other network initialisation.
33       * @throws CacheException
34       */
35      void init() throws CacheException;
36  
37      /**
38       * Stop the listener and free any resources.
39       * @throws CacheException
40       */
41      void dispose() throws CacheException;
42  
43      /**
44       * All of the caches which are listenting for remote changes.
45       * @return a list of <code>CachePeer</code> objects
46       */
47      List getBoundCachePeers();
48  
49  
50  
51  }