1 /**
2 * This file Copyright (c) 2013 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.module.InstallContext;
37
38 import java.util.List;
39
40 import javax.jcr.RepositoryException;
41 import javax.jcr.Session;
42
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45
46 /**
47 * Removes a list of nodes referenced by their absolute paths.<br>
48 * In case a {@link javax.jcr.Node} does not exist, logs an info message if the flag {@link #displayInfoMessageForMissingNodes} is set to true.<br>
49 * Otherwise just continues with the next absolute path from the list.
50 */
51 public class RemoveNodesTask extends AbstractRepositoryTask {
52
53 private static final Logger log = LoggerFactory.getLogger(RemoveNodesTask.class);
54
55 private final String workspaceName;
56 private final List<String> pathsToRemove;
57 private final boolean displayInfoMessageForMissingNodes;
58
59 public RemoveNodesTask(String name, String description, String workspaceName, List<String> pathsToRemove, boolean displayInfoMessageForMissingNodes) {
60 super(name, description);
61 this.pathsToRemove = pathsToRemove;
62 this.workspaceName = workspaceName;
63 this.displayInfoMessageForMissingNodes = displayInfoMessageForMissingNodes;
64 }
65
66 @Override
67 protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
68 Session session = ctx.getJCRSession(this.workspaceName);
69 for (String path : this.pathsToRemove) {
70 if (!session.itemExists(path)) {
71 if (this.displayInfoMessageForMissingNodes) {
72 ctx.info("Could not remove node '" + path + "' from workspace '" + this.workspaceName + "'. Node does not exist.");
73 }
74 log.debug("Could not remove node '{}' from workspace '{}'. Node does not exist.", path, this.workspaceName);
75 } else {
76 session.getItem(path).remove();
77 }
78 }
79 }
80 }