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.ui.dialog.action;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.api.action.AbstractAction;
38  import info.magnolia.ui.api.action.ActionExecutionException;
39  import info.magnolia.ui.api.app.SubAppEventBus;
40  import info.magnolia.ui.form.EditorCallback;
41  import info.magnolia.ui.form.EditorValidator;
42  import info.magnolia.ui.vaadin.integration.jcr.AbstractJcrNodeAdapter;
43  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
44  import info.magnolia.ui.vaadin.integration.jcr.JcrPropertyAdapter;
45  import info.magnolia.ui.vaadin.integration.jcr.JcrPropertyItemId;
46  import info.magnolia.ui.workbench.event.SelectionChangedEvent;
47  
48  import java.util.Arrays;
49  import java.util.HashSet;
50  
51  import javax.inject.Inject;
52  import javax.inject.Named;
53  import javax.jcr.Node;
54  import javax.jcr.RepositoryException;
55  
56  import org.slf4j.Logger;
57  import org.slf4j.LoggerFactory;
58  
59  import com.vaadin.v7.data.Item;
60  
61  /**
62   * The SaveConfigDialogAction is a special dialog commit action for saving configuration properties, when editing them in the Configuration app.
63   */
64  public class SaveConfigDialogAction extends AbstractAction<SaveConfigDialogActionDefinition> {
65  
66      private static final Logger log = LoggerFactory.getLogger(SaveConfigDialogAction.class);
67  
68      protected final Item item;
69  
70      protected final EditorValidator validator;
71      protected final EditorCallback callback;
72  
73      private final EventBus eventBus;
74  
75      @Inject
76      public SaveConfigDialogAction(SaveConfigDialogActionDefinition definition, Item item, EditorValidator validator, EditorCallback callback, final @Named(SubAppEventBus.NAME) EventBus eventBus) {
77          super(definition);
78          this.item = item;
79          this.validator = validator;
80          this.callback = callback;
81          this.eventBus = eventBus;
82      }
83  
84      @Override
85      public void execute() throws ActionExecutionException {
86          // First Validate
87          validator.showValidation(true);
88          if (validator.isValid()) {
89  
90              // we support only JCR item adapters
91              if (!(item instanceof JcrItemAdapter)) {
92                  return;
93              }
94  
95              // don't save if no value changes occurred on adapter
96              if (!((JcrItemAdapter) item).hasChangedProperties()) {
97                  return;
98              }
99  
100             if (item instanceof AbstractJcrNodeAdapter) {
101                 // Saving JCR Node, getting updated node first
102                 AbstractJcrNodeAdapteragnolia/ui/vaadin/integration/jcr/AbstractJcrNodeAdapter.html#AbstractJcrNodeAdapter">AbstractJcrNodeAdapter nodeAdapter = (AbstractJcrNodeAdapter) item;
103                 try {
104                     // get modifications
105                     Node node = nodeAdapter.applyChanges();
106                     node.getSession().save();
107                 } catch (RepositoryException e) {
108                     log.error("Could not save changes to node", e);
109                 }
110 
111             } else if (item instanceof JcrPropertyAdapter) {
112                 // Saving JCR Property, update it first
113                 JcrPropertyAdapteragnolia/ui/vaadin/integration/jcr/JcrPropertyAdapter.html#JcrPropertyAdapter">JcrPropertyAdapter propertyAdapter = (JcrPropertyAdapter) item;
114                 try {
115                     // get parent first because once property is updated, it won't exist anymore if the name changes
116                     Node parent = propertyAdapter.getJcrItem().getParent();
117 
118                     // get modifications
119                     propertyAdapter.applyChanges();
120                     parent.getSession().save();
121 
122                     // update workbench selection in case the property changed name
123                     JcrPropertyItemId newItemId = propertyAdapter.getItemId();
124                     eventBus.fireEvent(new SelectionChangedEvent(new HashSet<Object>(Arrays.asList(newItemId))));
125 
126                 } catch (RepositoryException e) {
127                     log.error("Could not save changes to property", e);
128                 }
129             }
130             callback.onSuccess(getDefinition().getName());
131         } else {
132             log.debug("Validation error(s) occurred. No save performed.");
133         }
134     }
135 
136 }