1 /**
2 * This file Copyright (c) 2015 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.setup;
35
36 import info.magnolia.jcr.util.NodeUtil;
37 import info.magnolia.module.InstallContext;
38 import info.magnolia.module.delta.AbstractRepositoryTask;
39 import info.magnolia.repository.RepositoryConstants;
40
41 import java.util.Arrays;
42 import java.util.List;
43
44 import javax.jcr.Node;
45 import javax.jcr.RepositoryException;
46
47 /**
48 * Excludes passed workspaces from cache flush policy.
49 */
50 public class ExcludeWorkspacesFromFlushCachePolicy extends AbstractRepositoryTask {
51
52 protected static final String EXCLUDED_WORKSPACES_CONFIG_PATH = "flushPolicy/policies/flushAll/excludedWorkspaces";
53 protected static final String CACHE_CONFIGURATION_PATH = "modules/cache/config/contentCaching/";
54
55 private final List<String> workspaceNames;
56
57 public ExcludeWorkspacesFromFlushCachePolicy(String... workspaceNames) {
58 super("Exclude workspace from flush cache policy", "Exclude from flush cache policy these workspaces: " + Arrays.asList(workspaceNames));
59 this.workspaceNames = Arrays.asList(workspaceNames);
60 }
61
62 @Override
63 public void doExecute(InstallContext ctx) throws RepositoryException {
64 Node root = ctx.getJCRSession(RepositoryConstants.CONFIG).getRootNode();
65 if (!root.hasNode(CACHE_CONFIGURATION_PATH)) {
66 return;
67 }
68 for (Node cache : NodeUtil.getNodes(root.getNode(CACHE_CONFIGURATION_PATH))) {
69 if (cache.hasNode(EXCLUDED_WORKSPACES_CONFIG_PATH)) {
70 Node excludedWorkspaces = cache.getNode(EXCLUDED_WORKSPACES_CONFIG_PATH);
71 for (String workspace : workspaceNames) {
72 excludedWorkspaces.setProperty(workspace, workspace);
73 }
74 }
75 }
76 }
77 }