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.inject.CacheFactoryProvider;
41  
42  import javax.inject.Inject;
43  
44  import org.apache.commons.lang3.StringUtils;
45  
46  /**
47   * Command to flush a cache by name.
48   */
49  public class FlushNamedCacheCommand extends MgnlCommand {
50  
51      public static final String CACHE_NAME = "cacheName";
52  
53      private final CacheFactoryProvider cacheFactoryProvider;
54      private String cacheName;
55  
56      @Inject
57      public FlushNamedCacheCommand(CacheFactoryProvider cacheFactoryProvider) {
58          this.cacheFactoryProvider = cacheFactoryProvider;
59      }
60  
61  
62      @Override
63      public boolean execute(Context context) throws Exception {
64          String cacheName = (String) context.get(CACHE_NAME);
65          if (StringUtils.isBlank(cacheName)) {
66              cacheName = getCacheName();
67          }
68          if(StringUtils.isNotBlank(cacheName)) {
69              CacheFactory factory = cacheFactoryProvider.get();
70              Cache cache = factory.getCache(cacheName);
71              if(cache != null) {
72                  cache.clear();
73              }
74          }
75          return true;
76      }
77  
78      public String getCacheName() {
79          return cacheName;
80      }
81  
82      public void setCacheName(String cacheName) {
83          this.cacheName = cacheName;
84      }
85  }