1 /**
2 * This file Copyright (c) 2012-2015 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.vaadin.integration.jcr;
35
36 import info.magnolia.ui.api.ModelConstants;
37
38 import java.util.HashMap;
39 import java.util.Map;
40 import java.util.Map.Entry;
41
42 import javax.jcr.Item;
43 import javax.jcr.RepositoryException;
44
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48 import com.vaadin.data.Property;
49
50 /**
51 * Common base for {@link JcrItemAdapter} implementation.
52 */
53 public abstract class AbstractJcrAdapter implements JcrItemAdapter {
54
55 private static final Logger log = LoggerFactory.getLogger(AbstractJcrAdapter.class);
56
57 protected static final String UNIDENTIFIED = "?";
58
59 private String workspace;
60
61 private String itemId;
62
63 private final Map<String, Property> changedProperties = new HashMap<String, Property>();
64
65 private final Map<String, Property> removedProperties = new HashMap<String, Property>();
66
67 public AbstractJcrAdapter(Item jcrItem) {
68 initCommonAttributes(jcrItem);
69 }
70
71 /**
72 * Init common Item attributes.
73 */
74 protected void initCommonAttributes(Item jcrItem) {
75 try {
76 workspace = jcrItem.getSession().getWorkspace().getName();
77 itemId = JcrItemUtil.getItemId(jcrItem);
78 } catch (RepositoryException e) {
79 log.error("Could not retrieve workspace or path of JCR Item.", e);
80 itemId = UNIDENTIFIED;
81 workspace = UNIDENTIFIED;
82 }
83 }
84
85 @Override
86 public String getWorkspace() {
87 return workspace;
88 }
89
90 @Override
91 public String getItemId() {
92 return itemId;
93 }
94
95 public void setItemId(String itemId) {
96 this.itemId = itemId;
97 }
98
99 @Override
100 public javax.jcr.Item getJcrItem() {
101 try {
102 return JcrItemUtil.getJcrItem(workspace, itemId);
103 } catch (RepositoryException re) {
104 log.warn("Not able to retrieve the JcrItem ", re.getMessage());
105 return null;
106 }
107 }
108
109 @Override
110 public boolean hasChangedProperties() {
111 return changedProperties.size() > 0;
112 }
113
114 // ABSTRACT IMPLEMENTATION OF PROPERTY CHANGES
115
116 protected Map<String, Property> getChangedProperties() {
117 return changedProperties;
118 }
119
120 protected Map<String, Property> getRemovedProperties() {
121 return removedProperties;
122 }
123
124 /**
125 * Updates and removes properties on given item, based on the {@link #changedProperties} and {@link #removedProperties} maps. Read-only properties will not be updated and null valued properties will get removed.
126 */
127 protected void updateProperties(Item item) throws RepositoryException {
128 for (Entry<String, Property> entry : changedProperties.entrySet()) {
129 if (entry.getValue().isReadOnly()) {
130 continue;
131 }
132 updateProperty(item, entry.getKey(), entry.getValue());
133 if (ModelConstants.JCR_NAME.equals(entry.getKey())) {
134 // As the item name has changed - the item must be refreshed to prevent an attempt to change property on an invalid old name.
135 item = getJcrItem();
136 }
137 }
138 }
139
140 /**
141 * Performs update of an Item based on given vaadin Property. Note that this should not persist changes into JCR.
142 * Implementation should simply make sure that updated propertyIds are mapped to the correct actions (jcrName
143 * property should be handled in a specific way).
144 */
145 protected abstract void updateProperty(Item item, String propertyId, Property property);
146
147 }