1 /**
2 * This file Copyright (c) 2014-2016 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;
35
36 import info.magnolia.config.map2bean.Map2BeanTransformer;
37 import info.magnolia.config.registry.Registry;
38 import info.magnolia.config.source.yaml.decoration.FilePathBasedYamlDefinitionDecoratorResolver;
39 import info.magnolia.resourceloader.Resource;
40 import info.magnolia.resourceloader.ResourceOrigin;
41
42 import java.util.regex.Pattern;
43
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46
47 /**
48 * Configuration source for yaml configuration files.
49 *
50 * @param <T> type the source will provide
51 */
52 public class YamlConfigurationSource<T> extends AbstractFileResourceConfigurationSource<T> {
53
54 private static Logger log = LoggerFactory.getLogger(YamlConfigurationSource.class);
55
56 private final Map2BeanTransformer map2BeanTransformer;
57
58 private final YamlReader yamlReader;
59
60 /**
61 * @param pathPattern a regular expression pattern used to determine whether a file should be considered by the source or not. If the pattern contains a group, it will be used to determine the name of the given object, if not explicitly configured.
62 */
63 public YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader) {
64 super(origin, registry, pathPattern);
65 this.map2BeanTransformer = map2BeanTransformer;
66 this.yamlReader = yamlReader;
67 }
68
69 @Override
70 protected void startDecoration() {
71 registerDefinitionDecoratorResolver(new FilePathBasedYamlDefinitionDecoratorResolver(map2BeanTransformer, getRegistry()));
72 super.startDecoration();
73 }
74
75 @Override
76 public void loadAndRegister(Resource resource) {
77 if (resource == null) {
78 throw new IllegalStateException("Resource cannot be null");
79 }
80
81 final YamlDefinitionProvider<T> definitionProvider = new YamlDefinitionProvider<>(
82 this,
83 resource,
84 map2BeanTransformer,
85 yamlReader);
86
87 getRegistry().register(definitionProvider);
88
89 log.info("Registered {} from {}", definitionProvider.getMetadata(), resource);
90 }
91 }