1 /**
2 * This file Copyright (c) 2017 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.virtualuri.setup.delta;
35
36 import info.magnolia.module.delta.ArrayDelegateTask;
37 import info.magnolia.module.delta.NodeExistsDelegateTask;
38 import info.magnolia.module.delta.RenameNodeTask;
39 import info.magnolia.repository.RepositoryConstants;
40 import info.magnolia.virtualuri.VirtualUriMapping;
41
42 import java.util.Map;
43
44 /**
45 * Task to update VirtualUriMappings for the magnolia-virtual-uri module.
46 * <ul>
47 * <li>node name virtualURIMapping will be changed to virtualUriMappings</li>
48 * <li>class property value will be updated by default class mapping, refer {@link UpdateMappingClassesAndPropertiesTask}</li>
49 * <li>toURI and fromURI properties will be changed to toUri and fromUri respectively.</li>
50 * </ul>
51 */
52 public class VirtualUriMappingUpdateTask extends NodeExistsDelegateTask {
53
54 static final String OLD_MAPPING_DIRECTORY = "virtualURIMapping";
55 static final String NEW_MAPPING_DIRECTORY = "virtualUriMappings";
56
57 public VirtualUriMappingUpdateTask(String name, String module, Map<String, Class<? extends VirtualUriMapping>> additionalMappingClasses) {
58 super(name, "/modules/" + module + "/" + OLD_MAPPING_DIRECTORY, createMappingArrayTask(module, additionalMappingClasses));
59 }
60
61 private static ArrayDelegateTask createMappingArrayTask(String module, Map<String, Class<? extends VirtualUriMapping>> additionalMappingClasses) {
62 String modulePath = "/modules/" + module;
63 ArrayDelegateTask mappingArrayTask = new ArrayDelegateTask("Task to update VirtualUriMapping for module" + module);
64 mappingArrayTask.addTask(new RenameNodeTask(String.format("Rename node name %s to %s", OLD_MAPPING_DIRECTORY, NEW_MAPPING_DIRECTORY), RepositoryConstants.CONFIG, modulePath, OLD_MAPPING_DIRECTORY, NEW_MAPPING_DIRECTORY, true));
65 mappingArrayTask.addTask(new UpdateMappingClassesAndPropertiesTask(String.format("Update VirtualUriMapping configurations of module %s", module), modulePath + "/" + NEW_MAPPING_DIRECTORY, additionalMappingClasses));
66 return mappingArrayTask;
67 }
68 }