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.event;
18
19 import net.sf.ehcache.CacheManager;
20
21 import java.util.Properties;
22
23 /***
24 * An abstract factory for creating {@link CacheManagerEventListener}s. Implementers should
25 * provide their own concrete factory extending this factory. It can then be configured in
26 * ehcache.xml
27 *
28 * @author Greg Luck
29 * @version $Id: CacheManagerEventListenerFactory.html 13146 2011-08-01 17:12:39Z oletizi $
30 * @see "http://ehcache.sourceforge.net/documentation/cachemanager_event_listeners.html"
31 */
32 public abstract class CacheManagerEventListenerFactory {
33
34 /***
35 * Create a <code>CacheEventListener</code>
36 *
37 *
38 * @param cacheManager the cache manager
39 * @param properties implementation specific properties. These are configured as comma
40 * separated name value pairs in ehcache.xml. Properties may be null
41 * @return a constructed CacheManagerEventListener
42 */
43 public abstract CacheManagerEventListener
44 createCacheManagerEventListener(CacheManager cacheManager, Properties properties);
45 }