1 /**
2 * This file Copyright (c) 2014-2015 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.Map2BeanTransformer;
37 import info.magnolia.config.source.jcr.JcrConfigurationSourceBuilder;
38 import info.magnolia.config.source.yaml.YamlConfigurationSourceBuilder;
39 import info.magnolia.config.source.yaml.YamlReader;
40 import info.magnolia.jcr.node2bean.Node2BeanProcessor;
41 import info.magnolia.module.ModuleRegistry;
42 import info.magnolia.resourceloader.ResourceOrigin;
43
44 import javax.inject.Inject;
45 import javax.inject.Singleton;
46
47 /**
48 * This factory provides builders for the default {@link info.magnolia.config.source.ConfigurationSource} implementations.
49 * If you implement your own {@link info.magnolia.config.source.ConfigurationSource}, you don't necessarily need
50 * to implement such a factory or even a {@link info.magnolia.config.source.ConfigurationSourceBuilder};
51 * the main goal of this class is to allow relatively fluent code to register sources and "hide" their dependencies
52 * (they're injected in this factory).
53 */
54 @Singleton
55 public class ConfigurationSourceFactory {
56
57 private final ResourceOrigin origin;
58 private final YamlReader yamlReader;
59 private final Map2BeanTransformer map2BeanTransformer;
60 private final Node2BeanProcessor node2BeanProcessor;
61 private final ModuleRegistry moduleRegistry;
62
63 @Inject
64 public ConfigurationSourceFactory(ResourceOrigin origin, YamlReader yamlReader, Map2BeanTransformer map2BeanTransformer, Node2BeanProcessor node2BeanProcessor, ModuleRegistry moduleRegistry) {
65 // We use a Provider<FileResourceLoader> so that we can get a new instance of the loader when we need.
66 // This is totally Guice-dependent though so we might think about using a Builder or Factory of ours instead.
67 // see YamlConfigurationSourceBuilder#bindTo(Registry)
68 this.origin = origin;
69 this.yamlReader = yamlReader;
70 this.map2BeanTransformer = map2BeanTransformer;
71 this.node2BeanProcessor = node2BeanProcessor;
72 this.moduleRegistry = moduleRegistry;
73 }
74
75 public YamlConfigurationSourceBuilder yaml() {
76 return new YamlConfigurationSourceBuilder(origin, map2BeanTransformer, yamlReader);
77 }
78
79 public JcrConfigurationSourceBuilder jcr() {
80 return new JcrConfigurationSourceBuilder(node2BeanProcessor, moduleRegistry);
81 }
82
83 public ConfigurationSourceBuilder code() {
84 throw new IllegalStateException("not yet");
85 }
86 }