View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.setup.for5_0;
35  
36  import info.magnolia.jcr.util.NodeTypes;
37  import info.magnolia.module.InstallContext;
38  import info.magnolia.module.delta.AbstractRepositoryTask;
39  import info.magnolia.module.delta.TaskExecutionException;
40  
41  import javax.jcr.Node;
42  import javax.jcr.RepositoryException;
43  
44  import org.slf4j.Logger;
45  import org.slf4j.LoggerFactory;
46  
47  /**
48   * This task checks whether the node specified by {@code workspace} and {@code path} constructor parameters has the {@code mgnl:lastActivated} property set,
49   * and if not, sets it to the current date &time (by calling {@link NodeTypes.Activatable#update(Node, String, boolean)}.
50   */
51  public class CheckOrCreateLastActivatedPropertyTask extends AbstractRepositoryTask {
52  
53      private static final Logger log = LoggerFactory.getLogger(CheckOrCreateLastActivatedPropertyTask.class);
54  
55      private final String workspace;
56      private final String path;
57  
58      /**
59       * @param path the workspace of the node mgnl:lastActivated property has to be set
60       * @param workspace the path of the node the mgnl:lastActivated property has to be set
61       */
62      public CheckOrCreateLastActivatedPropertyTask(String taskName, String taskDescription, String workspace, String path) {
63          super(taskName, taskDescription);
64          this.workspace = workspace;
65          this.path = path;
66      }
67  
68      @Override
69      protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
70          Node node = installContext.getJCRSession(workspace).getNode(path);
71          if (node.hasProperty(NodeTypes.Activatable.LAST_ACTIVATED)) {
72              log.debug("Node [{}] in workspace [{}] has the [{}] property already set, skipping.", path, workspace, NodeTypes.Activatable.LAST_ACTIVATED);
73              return;
74          }
75          log.debug("Updating activation status for node [{}] in workspace [{}].", path, workspace);
76          NodeTypes.Activatable.update(node, "superuser", true);
77      }
78  
79  }