Clover icon

Magnolia Module EhCache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:52:57 CET
  2. Package info.magnolia.module.cache.ehcache

File EhCacheConfiguration.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
1
1
1
76
13
1
1
1
1
1
50% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
EhCacheConfiguration 49 1 50% 1 0
1.0100%
 

Contributing tests

This file is covered by 1 test. .

Source view

1    /**
2    * This file Copyright (c) 2014-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.ehcache;
35   
36    import info.magnolia.jcr.node2bean.TransformedBy;
37   
38    import net.sf.ehcache.config.CacheConfiguration;
39   
40    /**
41    * A subclass of {@link CacheConfiguration} that exists mostly for the purpose of being able to define a Node2Bean transformer globally;
42    * it also exposes additional methods which help integrating with Magnolia or Node2Bean.
43    *
44    * @see EhCacheConfigurationTransformer
45    * @deprecated since 5.4.4. Ehcache2 implementation will be dropped in a next major version in favour of EhCache3. Use {@link info.magnolia.module.cache.ehcache3.configuration.EhCache3ConfigurationBuilder} instead.
46    */
47    @Deprecated
48    @TransformedBy(EhCacheConfigurationTransformer.class)
 
49    public class EhCacheConfiguration extends CacheConfiguration {
50   
51    /**
52    * Forces setting name to null - this is silly: setName() won't let us set it to null, but this.name is protected,
53    * so we can change it here anyway.
54    *
55    * The defaultCacheConfiguration should not have a name (it has one here, as a side-effect of node2bean auto-calling the setName method with a node's name)
56    * If we leave its name, ehcache throws an exception in net.sf.ehcache.config.Configuration.addCache because "The Default Cache has already been configured".
57    * (while really, the problem is that the default HAS a name, which indeed doesn't make sense)
58    * So, we have to hack around to remove it.
59    *
60    * @see info.magnolia.module.cache.CacheFactory#start
61    */
 
62  19 toggle void resetName() {
63  19 this.name = null;
64    }
65   
66    /**
67    * Allows setting a {@link net.sf.ehcache.config.PersistenceConfiguration} via Node2Bean; net.sf.ehcache.config.CacheConfiguration doesn't have
68    * a setter for this, just {@link #persistence(net.sf.ehcache.config.PersistenceConfiguration)} or {@link #addPersistence(net.sf.ehcache.config.PersistenceConfiguration)}.
69    *
70    * @see EhCachePersistenceConfiguration
71    */
 
72    toggle public void setPersistence(EhCachePersistenceConfiguration persistenceConfiguration) {
73    addPersistence(persistenceConfiguration);
74    }
75   
76    }