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