1 /**
2 * This file Copyright (c) 2003-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.delta;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.HierarchyManager;
38 import info.magnolia.cms.util.ContentUtil;
39 import info.magnolia.cms.util.HierarchyManagerUtil;
40 import info.magnolia.module.InstallContext;
41
42 import javax.jcr.Node;
43 import javax.jcr.RepositoryException;
44
45 /**
46 * An abstract that will perform an operation on all modules node found in the configuration repository.
47 *
48 * @see #operateOnChildNode(info.magnolia.cms.core.Content, info.magnolia.module.InstallContext)
49 *
50 * Warning: tasks will fail if the modules node does not exist yet. (As an incentive to force the explicit creation
51 * of this node)
52 *
53 * @deprecated since 5.6 - without replacement.
54 */
55 @Deprecated
56 public abstract class AllModulesNodeOperation extends AllChildrenNodesOperation {
57
58 public AllModulesNodeOperation(String name, String description) {
59 super(name, description, null, null);
60 }
61
62 protected HierarchyManager getHierarchyManager(InstallContext ctx) throws RepositoryException, TaskExecutionException {
63 return HierarchyManagerUtil.asHierarchyManager(ctx.getConfigJCRSession());
64 }
65
66 @Override
67 protected Content getParentNode(InstallContext ctx) throws RepositoryException, TaskExecutionException {
68 if (!ctx.hasModulesNode()) {
69 throw new TaskExecutionException("The main /modules node does not exist in the config repository, can not proceed.");
70 }
71 final Node modulesNode = ctx.getModulesNode();
72 return ContentUtil.asContent(modulesNode);
73 }
74
75 @Override
76 protected void operateOnChildNode(Content node, InstallContext ctx) throws RepositoryException, TaskExecutionException {
77 final HierarchyManager hierarchyManager = HierarchyManagerUtil.asHierarchyManager(ctx.getConfigJCRSession());
78 operateOnModuleNode(node, hierarchyManager, ctx);
79 }
80
81 protected abstract void operateOnModuleNode(Content node, HierarchyManager hm, InstallContext ctx) throws RepositoryException, TaskExecutionException;
82 }