1 /**
2 * This file Copyright (c) 2017-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.yaml.construct;
35
36 import static info.magnolia.config.maputil.ToMap.toMap;
37 import static info.magnolia.config.source.yaml.dependency.YamlDependencyResoutionProblemType.DEPENDENCY_RESOLUTION;
38
39 import info.magnolia.config.maputil.ConfigurationMapOverlay;
40 import info.magnolia.config.registry.DefinitionProvider.Problem;
41
42 import java.util.function.Consumer;
43
44 import org.apache.commons.lang3.StringUtils;
45 import org.yaml.snakeyaml.nodes.Node;
46 import org.yaml.snakeyaml.nodes.ScalarNode;
47
48 /**
49 * Custom SnakeYAML construct strictly bound to the <b>!override</b> YAML tag.
50 *
51 * Adds an override instruction to the configuration data parsed from the YAML node. This construct should be used when some of the annotated
52 * node's parents uses extension annotations (see {@link InheritDefinition}). In such case the configuration sub-tree which corresponds to
53 * a node with <b>!override</b> annotation will not be merged with the source config, but instead will be used as is
54 * (similar to the 'extends-override' instruction in JCR).
55 */
56 public final class OverrideSource extends MgnlYamlConstruct {
57
58 public static final String TAG = "!override";
59
60 public OverrideSource(Consumer<Problem> problemCollector) {
61 super(problemCollector);
62 }
63
64 @Override
65 public Object construct(Node node) {
66 if (node instanceof ScalarNode) {
67 if (StringUtils.isNotBlank(((ScalarNode) node).getValue())) {
68 reportProblem(
69 Problem.minor()
70 .withType(DEPENDENCY_RESOLUTION)
71 .withTitle("Redundant !override instruction used")
72 .withDetails(String.format("Node [%s] is a scalar, !override tag is redundant in this case", node.getNodeId()))
73 .build());
74 }
75 }
76
77 final Object baseValue = getConstructor().getConstructByNodeType(node).construct(node);
78
79 return new ConfigurationMapOverlay.OverridingMap<>(toMap(baseValue));
80 }
81
82 }