View Javadoc
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.jcr.node2bean.impl;
35  
36  import info.magnolia.jcr.decoration.ContentDecorator;
37  import info.magnolia.jcr.iterator.FilteringPropertyIterator;
38  import info.magnolia.jcr.node2bean.Node2BeanException;
39  import info.magnolia.jcr.node2bean.Node2BeanProcessor;
40  import info.magnolia.jcr.node2bean.Node2BeanTransformer;
41  import info.magnolia.jcr.node2bean.PropertyTypeDescriptor;
42  import info.magnolia.jcr.node2bean.TransformationState;
43  import info.magnolia.jcr.node2bean.TypeDescriptor;
44  import info.magnolia.jcr.node2bean.TypeMapping;
45  import info.magnolia.jcr.predicate.AbstractPredicate;
46  import info.magnolia.jcr.util.NodeTypes;
47  import info.magnolia.jcr.util.NodeUtil;
48  import info.magnolia.jcr.util.PropertyUtil;
49  import info.magnolia.jcr.wrapper.ExtendingNodeWrapper;
50  import info.magnolia.objectfactory.ComponentProvider;
51  import info.magnolia.objectfactory.Components;
52  
53  import java.util.Collection;
54  import java.util.LinkedHashMap;
55  import java.util.Map;
56  
57  import javax.inject.Inject;
58  import javax.inject.Singleton;
59  import javax.jcr.Node;
60  import javax.jcr.NodeIterator;
61  import javax.jcr.Property;
62  import javax.jcr.PropertyIterator;
63  import javax.jcr.RepositoryException;
64  
65  import org.slf4j.Logger;
66  import org.slf4j.LoggerFactory;
67  
68  /**
69   * Contains the logic for traversing the hierarchy and do the calls to the transformer.
70   */
71  @Singleton
72  public class Node2BeanProcessorImpl implements Node2BeanProcessor {
73      private static final Logger log = LoggerFactory.getLogger(Node2BeanProcessorImpl.class);
74  
75      private final TypeMapping typeMapping;
76  
77      private final Node2BeanTransformer defaultTransformer;
78  
79      private boolean forceCreation = true;
80  
81      @Inject
82      public Node2BeanProcessorImpl(TypeMapping typeMapping, Node2BeanTransformer transformer) {
83          this.typeMapping = typeMapping;
84          this.defaultTransformer = transformer;
85      }
86  
87      @Override
88      public Object toBean(Node node) throws Node2BeanException, RepositoryException {
89          return toBean(node, true, defaultTransformer, defaultTransformer.newState(), Components.getComponentProvider());
90      }
91  
92      @Override
93      public Object toBean(Node node, final Class<?> defaultClass) throws Node2BeanException, RepositoryException {
94          return toBean(node, true, new Node2BeanTransformerImpl() {
95              @Override
96              protected TypeDescriptor onResolveType(TypeMapping mapping, TransformationState state, TypeDescriptor resolvedType, ComponentProvider componentProvider) {
97                  if (resolvedType == null && state.getLevel() == 1) {
98                      return mapping.getTypeDescriptor(defaultClass);
99                  }
100                 return resolvedType;
101             }
102         }, defaultTransformer.newState(), Components.getComponentProvider());
103     }
104 
105     @Override
106     public Object toBean(Node node, boolean recursive, final Node2BeanTransformer transformer, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException {
107         return toBean(node, recursive, transformer, transformer.newState(), componentProvider);
108     }
109 
110     protected Object toBean(Node node, boolean recursive, Node2BeanTransformer transformer, TransformationState state, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException {
111         if (!NodeUtil.isWrappedWith(node, ExtendingNodeWrapper.class)) {
112             node = new ExtendingNodeWrapper(node);
113         }
114         state.pushNode(node);
115         TypeDescriptor type = null;
116         try {
117             type = transformer.resolveType(typeMapping, state, componentProvider);
118         } catch (Throwable e) {
119             if (isForceCreation()) {
120                 log.warn("can't resolve class for node {}", node.getPath(), e);
121             } else {
122                 throw new Node2BeanException("can't resolve class for node " + node.getPath(), e);
123             }
124         }
125 
126         Object bean = null;
127         if (type != null) {
128             state.pushType(type);
129 
130             transformer = resolveTransformer(type, transformer);
131 
132             Map<String, Object> values = toMap(node, recursive, transformer, state, componentProvider);
133 
134             try {
135                 bean = transformer.newBeanInstance(state, values, componentProvider);
136             } catch (Throwable e) {
137                 if (isForceCreation()) {
138                     log.warn("Can't instantiate bean for {}", node.getPath(), e);
139                 } else {
140                     throw new Node2BeanException("Can't instantiate bean for " + node.getPath(), e);
141                 }
142             }
143 
144             if (bean != null) {
145                 state.pushBean(bean);
146 
147                 setProperties(values, transformer, state);
148 
149                 transformer.initBean(state, values);
150 
151                 bean = state.getCurrentBean();
152 
153                 state.popBean();
154             } else {
155                 if (forceCreation) {
156                     log.warn("can't instantiate bean of type {} for node {}", type.getType().getName(), node.getPath());
157                 } else {
158                     throw new Node2BeanException("can't instantiate bean of type " + type.getType().getName());
159                 }
160             }
161 
162             state.popType();
163         }
164         state.popNode();
165 
166         return bean;
167     }
168 
169     @Override
170     public Object setProperties(final Object bean, Node node, boolean recursive, Node2BeanTransformer transformer, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException {
171         // enable extending feature
172         node = new ExtendingNodeWrapper(node);
173 
174         TransformationState state = transformer.newState();
175         state.pushBean(bean);
176         state.pushNode(node);
177 
178         TypeDescriptor type = typeMapping.getTypeDescriptor(bean.getClass());
179 
180         state.pushType(type);
181 
182         transformer = resolveTransformer(type, transformer);
183 
184         Map<String, Object> values = toMap(node, recursive, transformer, state, componentProvider);
185 
186         setProperties(values, transformer, state);
187 
188         transformer.initBean(state, values);
189 
190         state.popBean();
191         state.popType();
192         state.popNode();
193 
194         return bean;
195     }
196 
197     /**
198      * Transforms the children of provided content into a map.
199      */
200     protected Map<String, Object> toMap(Node node, boolean recursive, Node2BeanTransformer transformer, TransformationState state, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException {
201         Map<String, Object> map = new LinkedHashMap<String, Object>();
202         PropertyIterator it = new FilteringPropertyIterator(node.getProperties(), new AbstractPredicate<Property>() {
203             @Override
204             public boolean evaluateTyped(Property t) {
205                 try {
206                     return !(t.getName().startsWith(NodeTypes.JCR_PREFIX) || t.getName().startsWith(NodeTypes.MGNL_PREFIX));
207                 } catch (RepositoryException e) {
208                     return false;
209                 }
210             }
211         }, (ContentDecorator) null);
212         while (it.hasNext()) {
213             Property p = it.nextProperty();
214             Object val = PropertyUtil.getValueObject(p.getValue());
215             if (val != null) {
216                 map.put(p.getName(), val);
217             }
218         }
219         if (recursive) {
220             final NodeIterator children = transformer.getChildren(node);
221 
222             while (children.hasNext()) {
223                 Node childNode = (Node) children.next();
224                 // in case the the class can not get resolved we can use now
225                 // the parent bean to resolve the class
226 
227                 Object childBean = toBean(childNode, true, transformer, state, componentProvider);
228                 // can be null if forceCreation is true
229                 if (childBean != null) {
230                     String name = childNode.getName();
231                     try {
232                         if (childNode.getIndex() > 1) {
233                             name += childNode.getIndex();
234                         }
235                     } catch (RepositoryException e) {
236                         log.error("can't read index of the node [{}]", childNode, e);
237                     }
238                     map.put(name, childBean);
239                 }
240             }
241         }
242 
243         return map;
244     }
245 
246     /**
247      * Populates the properties of the bean with values from the map.
248      * TODO in case the bean is a map / collection the transfomer.setProperty() method should be called too
249      * TODO if the bean has not a certain property but a value is present, transformer.setProperty() should be called with a fake property descriptor
250      */
251     protected void setProperties(Map<String, Object> values, final Node2BeanTransformer transformer, TransformationState state) throws Node2BeanException, RepositoryException {
252         Object bean = state.getCurrentBean();
253         log.debug("will populate bean {} with the values {}", bean.getClass().getName(), values);
254 
255         if (bean instanceof Map) {
256             ((Map<String, Object>) bean).putAll(values);
257         }
258 
259         if (bean instanceof Collection) {
260             ((Collection<Object>) bean).addAll(values.values());
261         } else {
262             TypeDescriptor beanTypeDescriptor = typeMapping.getTypeDescriptor(bean.getClass());
263             final Collection<PropertyTypeDescriptor> dscrs = beanTypeDescriptor.getPropertyDescriptors(typeMapping).values();
264 
265             for (PropertyTypeDescriptor descriptor : dscrs) {
266                 transformer.setProperty(typeMapping, state, descriptor, values);
267             }
268         }
269     }
270 
271     protected Node2BeanTransformer resolveTransformer(TypeDescriptor type, Node2BeanTransformer transformer) {
272         Node2BeanTransformer customTransformer = type.getTransformer();
273         if (customTransformer != null) {
274             transformer = customTransformer;
275         }
276         return transformer;
277     }
278 
279     public boolean isForceCreation() {
280         return this.forceCreation;
281     }
282 
283     public void setForceCreation(boolean forceCreation) {
284         this.forceCreation = forceCreation;
285     }
286 }