1 /**
2 * This file Copyright (c) 2008-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.cache;
35
36 import info.magnolia.module.ModuleLifecycle;
37 import info.magnolia.module.cache.mbean.CacheMonitor;
38
39 import javax.inject.Inject;
40
41 /**
42 * The base class for cache modules.
43 */
44 public abstract class AbstractCacheModule implements ModuleLifecycle {
45
46 public static final String DEFAULT_CACHE_CONFIG = "defaultPageCache";
47 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AbstractCacheModule.class);
48
49 private final CacheMonitor cacheMonitor;
50
51 @Inject
52 public AbstractCacheModule(CacheMonitor cacheMonitor) {
53 this.cacheMonitor = cacheMonitor;
54 }
55
56 public abstract ContentCachingConfiguration getContentCaching(String name);
57
58 protected abstract CacheFactory getCacheFactory();
59
60 protected void startCache(String name) {
61 final Cache cache = getCacheFactory().getCache(name);
62 cacheMonitor.addCache(name);
63 ContentCachingConfiguration cfg = this.getContentCaching(name);
64 if (cfg.getFlushPolicy() != null) {
65 cfg.getFlushPolicy().start(cache); //default flush policy can be shared between multiple caches but we need to start it for every cache to register listeners
66 } else {
67 log.warn("Flush Policy is not configured properly for {} cache configuration.", name);
68 }
69 }
70
71 protected void stopCache(String name) {
72 Cache cache = null;
73 ContentCachingConfiguration cfg = this.getContentCaching(name);
74 try {
75 cache = getCacheFactory().getCache(name);
76 } catch (IllegalStateException e) {
77 log.warn("Cache {} is not running anymore. Check your configuration and log files to find out if there were any errors forcing cache shutdown.", name);
78 }
79 if (cfg.getFlushPolicy() != null) {
80 cfg.getFlushPolicy().stop(cache);
81 } else {
82 log.warn("Flush Policy is not configured properly for {} cache configuration.", name);
83 }
84 }
85
86 protected CacheMonitor getCacheMonitor() {
87 return cacheMonitor;
88 }
89
90 }