1 /**
2 * This file Copyright (c) 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.form.fieldtype.resolver;
35
36 import info.magnolia.config.registry.Registry;
37 import info.magnolia.jcr.node2bean.TypeDescriptor;
38 import info.magnolia.objectfactory.annotation.Multibinding;
39 import info.magnolia.transformer.TypeResolver;
40 import info.magnolia.ui.form.field.definition.FieldDefinition;
41 import info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry;
42
43 import java.util.Map;
44 import java.util.Optional;
45
46 import javax.inject.Inject;
47
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
50
51 /**
52 * Capable of deducing the exact {@link info.magnolia.ui.form.fieldtype.definition.FieldTypeDefinition field definition}
53 * types via short references instead of the fully-qualified class names.
54 * Such references must correspond to the names of the respective {@link info.magnolia.ui.form.fieldtype.definition.FieldTypeDefinition field type definitions}
55 * which are stored at {@link FieldTypeDefinitionRegistry}. The references are expected to be provided as values of
56 * <b>"{@value FIELD_TYPE_PROPERTY}"</b> property.
57 *
58 * <p><strong>NOTE:</strong> For the time being this class is meant for the internal use only
59 * and is a subject to change any moment!</p>
60 *
61 * @see info.magnolia.transformer.BeanTypeResolver
62 */
63 @Multibinding
64 public final class FieldTypeResolver implements TypeResolver {
65
66 private static final Logger log = LoggerFactory.getLogger(FieldTypeResolver.class);
67 private static final String FIELD_TYPE_PROPERTY = "fieldType";
68
69 private final FieldTypeDefinitionRegistry fieldTypeRegistry;
70
71 @Inject
72 public FieldTypeResolver(FieldTypeDefinitionRegistry fieldTypeRegistry) {
73 this.fieldTypeRegistry = fieldTypeRegistry;
74 }
75
76 @Override
77 public Optional<Class<?>> resolve(Map<String, Object> properties) {
78 if (properties.containsKey(FIELD_TYPE_PROPERTY)) {
79 Object fieldTypeObject = properties.get(FIELD_TYPE_PROPERTY);
80 // Present map entry with null value potentially causing NPE.
81 if (fieldTypeObject == null) {
82 return Optional.empty();
83 }
84
85 String fieldType = fieldTypeObject.toString().trim();
86 try {
87 return Optional.of(fieldTypeRegistry.getProvider(fieldType).get().getDefinitionClass());
88 } catch (Registry.NoSuchDefinitionException e) {
89 log.warn("Encountered the '{}' property but failed to resolved the type from its value: [{}]", FIELD_TYPE_PROPERTY, fieldType, e);
90 }
91 }
92 return Optional.empty();
93 }
94
95 @Override
96 public boolean supportsType(TypeDescriptor typeDescriptor) {
97 return typeDescriptor != null && typeDescriptor.getType() != null && FieldDefinition.class.isAssignableFrom(typeDescriptor.getType());
98 }
99 }