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 FlushFromCachesByUUIDCommand.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart7.png
45% of files have more coverage

Code metrics

6
20
3
1
125
70
6
0.3
6.67
3
2
21.6% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
FlushFromCachesByUUIDCommand 58 20 21.6% 6 10
0.655172465.5%
 

Contributing tests

This file is covered by 1 test. .

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.CacheModule;
41    import info.magnolia.module.cache.CachePolicy;
42    import info.magnolia.module.cache.ContentCachingConfiguration;
43    import info.magnolia.module.cache.cachepolicy.Never;
44    import info.magnolia.objectfactory.Components;
45   
46    import java.util.Arrays;
47    import java.util.Collection;
48    import java.util.HashSet;
49    import java.util.Set;
50   
51    import javax.inject.Inject;
52   
53    import org.apache.commons.lang3.StringUtils;
54   
55    /**
56    * Command to completely flush all entries related to given uuid from all available caches.
57    */
 
58    public class FlushFromCachesByUUIDCommand extends MgnlCommand {
59   
60    public static final String WORKSPACE = "repository";
61    public static final String UUID = "uuid";
62   
63    private final CacheModule cacheModule;
64    private String uuid;
65    private String workspace;
66   
67    /**
68    * @deprecated since 5.4. Use {@link #FlushFromCachesByUUIDCommand(info.magnolia.module.cache.CacheModule)} instead.
69    */
 
70  0 toggle @Deprecated
71    public FlushFromCachesByUUIDCommand() {
72  0 this(Components.getComponent(CacheModule.class));
73    }
74   
 
75  1 toggle @Inject
76    public FlushFromCachesByUUIDCommand(CacheModule cacheModule) {
77  1 this.cacheModule = cacheModule;
78    }
79   
 
80  1 toggle @Override
81    public boolean execute(Context ctx) throws Exception {
82  1 String uuid = (String) ctx.get(UUID);
83  1 if (StringUtils.isBlank(uuid)) {
84  1 uuid = getUuid();
85    }
86  1 String workspace = (String) ctx.get(WORKSPACE);
87  1 if (StringUtils.isBlank(workspace)) {
88  1 workspace = getWorkspace();
89    }
90  1 final Set<Object> keySet = new HashSet<Object>();
91  1 Collection<ContentCachingConfiguration> cacheConfigs = cacheModule.getContentCaching().values();
92  1 for (ContentCachingConfiguration config : cacheConfigs) {
93  1 if (!(config.getCachePolicy() instanceof Never)) {
94  0 CachePolicy policy = config.getCachePolicy();
95  0 keySet.addAll(Arrays.asList(policy.removeCacheKeys(uuid, workspace)));
96    }
97    }
98   
99  1 CacheFactory factory = cacheModule.getCacheFactory();
100    // flush each key from all caches
101  1 for (Object key : keySet) {
102  0 for (ContentCachingConfiguration config : cacheConfigs) {
103  0 final Cache cache = factory.getCache(config.getCacheName());
104  0 cache.remove(key);
105    }
106    }
107  1 return true;
108    }
109   
 
110    toggle public String getUuid() {
111    return uuid;
112    }
113   
 
114    toggle public void setUuid(String uuid) {
115    this.uuid = uuid;
116    }
117   
 
118    toggle public String getWorkspace() {
119    return workspace;
120    }
121   
 
122    toggle public void setWorkspace(String workspace) {
123    this.workspace = workspace;
124    }
125    }