View Javadoc
1   /**
2    * This file Copyright (c) 2020 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.resources.app.action;
35  
36  import info.magnolia.resourceloader.Resource;
37  import info.magnolia.resourceloader.ResourceOrigin;
38  import info.magnolia.resources.app.data.ResourceHelper;
39  import info.magnolia.ui.CloseHandler;
40  import info.magnolia.ui.ValueContext;
41  import info.magnolia.ui.api.action.ActionExecutionException;
42  import info.magnolia.ui.contentapp.Datasource;
43  import info.magnolia.ui.contentapp.action.CloseAction;
44  import info.magnolia.ui.editor.FormView;
45  import info.magnolia.ui.editor.JcrBinaryHelper;
46  import info.magnolia.ui.observation.DatasourceObservation;
47  
48  import javax.jcr.Node;
49  
50  /**
51   * Abstract class for adding a resource to the workspace tree.
52   * The implementation can be customized by overriding {@link AbstractAddResourceAction#addResource(Resource, Node)}.
53   */
54  public abstract class AbstractAddResourceAction  extends CloseAction<AddResourceActionDefinition> implements ResourceHelper, JcrBinaryHelper {
55  
56      private final ValueContext<Resource> valueContext;
57      private final FormView<Resource> form;
58      private final Datasource<Resource> datasource;
59      private final DatasourceObservation.Manual datasourceObservation;
60      private final ResourceOrigin resourceOrigin;
61  
62      public AbstractAddResourceAction(AddResourceActionDefinition definition, CloseHandler closeHandler,
63                                  ValueContext<Resource> valueContext, FormView<Resource> form,
64                                  Datasource<Resource> datasource,
65                                  DatasourceObservation.Manual datasourceObservation,
66                                  ResourceOrigin resourceOrigin) {
67          super(definition, closeHandler);
68          this.form = form;
69          this.valueContext = valueContext;
70          this.datasource = datasource;
71          this.datasourceObservation = datasourceObservation;
72          this.resourceOrigin = resourceOrigin;
73      }
74  
75      @Override
76      public void execute() throws ActionExecutionException {
77          Resource selectedResource = valueContext.getSingle().orElse(resourceOrigin.getRoot());
78          Node rootNode = getJcrNode(selectedResource.getOrigin().getRoot()).orElseThrow(() -> new IllegalStateException("Can't " +
79                  "retrieve root node from " + selectedResource));
80  
81          addResource(selectedResource, rootNode);
82  
83          datasourceObservation.trigger();
84          super.execute();
85      }
86  
87      /**
88       * Add custom implementation for adding a resource by overriding this method.
89       *
90       * @param parent The resource to which resource being created is to be added.
91       * @param rootNode The root node in the workspace.
92       */
93      protected abstract void addResource(Resource parent, Node rootNode);
94  }