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