1 /**
2 * This file Copyright (c) 2017 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.transformer;
35
36 import info.magnolia.jcr.node2bean.TypeDescriptor;
37 import info.magnolia.objectfactory.Classes;
38 import info.magnolia.objectfactory.annotation.Multibinding;
39
40 import java.util.Map;
41 import java.util.Optional;
42
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45
46 /**
47 * {@link TypeResolver} implementation which relies on the presence of the <b>"{@value CLASS_PROPERTY}"</b>
48 * property in the provided bean related data. In order to successfully conduct the resolution this
49 * resolver expects property value to contain the fully-qualified class name.
50 *
51 * <p><strong>NOTE:</strong> For the time being this class is meant for the internal use only
52 * and is a subject to change any moment!</p>
53 */
54 @Multibinding
55 public final class ClassPropertyBasedTypeResolver implements TypeResolver {
56
57 private static final Logger log = LoggerFactory.getLogger(ClassPropertyBasedTypeResolver.class);
58 private static final String CLASS_PROPERTY = "class";
59
60 @Override
61 public Optional<Class<?>> resolve(Map<String, Object> properties) {
62 if (properties.containsKey(CLASS_PROPERTY)) {
63 Object classObject = properties.get(CLASS_PROPERTY);
64 // Present map entry with null value potentially causing NPE.
65 if (classObject == null) {
66 return Optional.empty();
67 }
68
69 String className = classObject.toString().trim();
70 try {
71 return Optional.of(Classes.getClassFactory().forName(className));
72 } catch (ClassNotFoundException e) {
73 log.warn("Encountered the '{}' property but failed to resolved the type from its value: [{}]", CLASS_PROPERTY, className, e);
74 }
75 }
76 return Optional.empty();
77 }
78
79 @Override
80 public boolean supportsType(TypeDescriptor typeDescriptor) {
81 return true;
82 }
83 }