View Javadoc

1   /***
2    *  Copyright 2003-2010 Terracotta, Inc.
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.CacheManager;
20  
21  import java.util.Properties;
22  
23  /***
24   * An abstract factory for creating cache manager peer listeners. Implementers should provide their own
25   * concrete factory extending this factory. It can then be configured in ehcache.xml
26   * <p/>
27   * This enables listener plugins.
28   * @author Greg Luck
29   * @version $Id: CacheManagerPeerListenerFactory.html 13146 2011-08-01 17:12:39Z oletizi $
30   */
31  public abstract class CacheManagerPeerListenerFactory {
32  
33      /***
34       * Creates a peer provider.
35       * @param cacheManager the CacheManager instance connected to this peer provider
36       * @param properties implementation specific properties. These are configured as comma
37       * separated name value pairs in ehcache.xml
38       * @return a constructed CacheManagerPeerProvider
39       */
40      public abstract CacheManagerPeerListener createCachePeerListener(CacheManager cacheManager, Properties properties);
41  
42  
43  
44  }