Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache

File AbstractCacheModule.java

 

Coverage histogram

../../../../img/srcFileCovDistChart1.png
74% of files have more coverage

Code metrics

4
12
4
1
84
36
6
0.5
3
4
1.5

Classes

Class Line # Actions
AbstractCacheModule 44 12 0% 6 18
0.110%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2008-2018 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  42 toggle @Inject
52    public AbstractCacheModule(CacheMonitor cacheMonitor) {
53  42 this.cacheMonitor = cacheMonitor;
54    }
55   
56    public abstract ContentCachingConfiguration getContentCaching(String name);
57   
58    protected abstract CacheFactory getCacheFactory();
59   
 
60  0 toggle protected void startCache(String name) {
61  0 final Cache cache = getCacheFactory().getCache(name);
62  0 cacheMonitor.addCache(name);
63  0 ContentCachingConfiguration cfg = this.getContentCaching(name);
64  0 if (cfg.getFlushPolicy() != null) {
65  0 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  0 log.warn("Flush Policy is not configured properly for {} cache configuration.", name);
68    }
69    }
70   
 
71  0 toggle protected void stopCache(String name) {
72  0 ContentCachingConfiguration cfg = this.getContentCaching(name);
73  0 if (cfg.getFlushPolicy() != null) {
74  0 cfg.getFlushPolicy().stop(getCacheFactory().getCache(name));
75    } else {
76  0 log.warn("Flush Policy is not configured properly for {} cache configuration.", name);
77    }
78    }
79   
 
80  0 toggle protected CacheMonitor getCacheMonitor() {
81  0 return cacheMonitor;
82    }
83   
84    }