1 /**
2 * This file Copyright (c) 2016-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.config.source;
35
36 import info.magnolia.config.map2bean.ConfigurationParsingException;
37 import info.magnolia.config.map2bean.Map2BeanTransformer;
38 import info.magnolia.config.registry.DefinitionProvider;
39 import info.magnolia.config.registry.DefinitionRawView;
40 import info.magnolia.config.source.raw.DefinitionRawViewMapWrapper;
41
42 import java.util.List;
43 import java.util.Map;
44
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48 /**
49 * {@link info.magnolia.config.registry.DefinitionProviderWrapper definition provider wrapper} which constructs a new version of a provided bean from a {@link Map}. Resulting bean, however,
50 * falls back to the wrapped provider's bean for un-resolved properties.
51 *
52 * @param <T> wrapped provider's definition type
53 */
54 public class MapBasedDefinitionProviderWrapper<T> extends DefinitionProviderWrapperWithProxyFallback<T> {
55
56 private static final Logger log = LoggerFactory.getLogger(MapBasedDefinitionProviderWrapper.class);
57
58 private final Map2BeanTransformer map2BeanTransformer;
59
60 private final Map<String, Object> mapRepresentation;
61
62 private T definition = null;
63
64 public MapBasedDefinitionProviderWrapper(DefinitionProvider<T> definitionProvider, Map2BeanTransformer map2BeanTransformer, Map<String, Object> mapRepresentation) {
65 super(definitionProvider);
66 this.map2BeanTransformer = map2BeanTransformer;
67 this.mapRepresentation = mapRepresentation;
68 }
69
70 @Override
71 protected T doGet() {
72 if (definition == null) {
73 try {
74 //noinspection unchecked
75 definition = (T) map2BeanTransformer.toBean(mapRepresentation, getMetadata().getType().baseClass());
76 } catch (ReflectiveOperationException | ConfigurationParsingException e) {
77 log.debug("Failed to execute decoration of [{}] via map-to-bean transformation due to: {}. Returning null...", getDelegate().getMetadata(), e.getMessage(), e);
78 definition = null;
79 }
80 }
81
82 return definition;
83 }
84
85 @Override
86 public DefinitionRawView getRaw() {
87 return new DefinitionRawViewMapWrapper(mapRepresentation);
88 }
89
90 @Override
91 public boolean isValid() {
92 // TODO - decorate this method with possible errors after resulting map2bean conversion
93 return super.isValid();
94 }
95
96 @Override
97 public List<String> getErrorMessages() {
98 // TODO - decorate this method with possible errors after resulting map2bean conversion
99 return super.getErrorMessages();
100 }
101 }