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.commands

File FlushNamedCacheCommand.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart0.png
75% of files have more coverage

Code metrics

6
11
3
1
94
43
6
0.55
3.67
3
2
16.7% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
FlushNamedCacheCommand 50 11 16.7% 6 20
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2010-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.commands;
35   
36    import info.magnolia.commands.MgnlCommand;
37    import info.magnolia.context.Context;
38    import info.magnolia.module.cache.Cache;
39    import info.magnolia.module.cache.CacheFactory;
40    import info.magnolia.module.cache.inject.CacheFactoryProvider;
41    import info.magnolia.objectfactory.Components;
42   
43    import javax.inject.Inject;
44   
45    import org.apache.commons.lang3.StringUtils;
46   
47    /**
48    * Command to flush a cache by name.
49    */
 
50    public class FlushNamedCacheCommand extends MgnlCommand {
51   
52    public static final String CACHE_NAME = "cacheName";
53   
54    private final CacheFactoryProvider cacheFactoryProvider;
55    private String cacheName;
56   
57    /**
58    * @deprecated since 5.4. Use {@link #FlushNamedCacheCommand(info.magnolia.module.cache.inject.CacheFactoryProvider)} instead.
59    */
 
60  0 toggle @Deprecated
61    public FlushNamedCacheCommand() {
62  0 this(Components.getComponent(CacheFactoryProvider.class));
63    }
64   
 
65  0 toggle @Inject
66    public FlushNamedCacheCommand(CacheFactoryProvider cacheFactoryProvider) {
67  0 this.cacheFactoryProvider = cacheFactoryProvider;
68    }
69   
70   
 
71  0 toggle @Override
72    public boolean execute(Context context) throws Exception {
73  0 String cacheName = (String) context.get(CACHE_NAME);
74  0 if (StringUtils.isBlank(cacheName)) {
75  0 cacheName = getCacheName();
76    }
77  0 if(StringUtils.isNotBlank(cacheName)) {
78  0 CacheFactory factory = cacheFactoryProvider.get();
79  0 Cache cache = factory.getCache(cacheName);
80  0 if(cache != null) {
81  0 cache.clear();
82    }
83    }
84  0 return true;
85    }
86   
 
87    toggle public String getCacheName() {
88    return cacheName;
89    }
90   
 
91    toggle public void setCacheName(String cacheName) {
92    this.cacheName = cacheName;
93    }
94    }