View Javadoc

1   /**
2    * This file Copyright (c) 2010-2010 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.ModuleRegistry;
39  import info.magnolia.module.cache.Cache;
40  import info.magnolia.module.cache.CacheFactory;
41  import info.magnolia.module.cache.CacheModule;
42  
43  import org.apache.commons.lang.StringUtils;
44  
45  /**
46   * Command to flush a cache by name.
47   * @author Bert Leunis
48   *
49   */
50  public class FlushNamedCacheCommand extends MgnlCommand {
51  
52      public static final String CACHE_NAME = "cacheName";
53      private final CacheModule cacheModule;
54  
55      public FlushNamedCacheCommand() {
56          cacheModule = ModuleRegistry.Factory.getInstance().getModuleInstance(CacheModule.class);
57      }
58  
59      @Override
60      public boolean execute(Context context) throws Exception {
61          String cacheName = (String) context.get(CACHE_NAME);
62          if(StringUtils.isNotBlank(cacheName)) {
63              CacheFactory factory = cacheModule.getCacheFactory();
64              Cache cache = factory.getCache(cacheName);
65              if(cache != null) {
66                  cache.clear();
67              }
68          }
69          return true;
70      }
71  
72  }