1 /**
2 * This file Copyright (c) 2011 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.init;
35
36 import info.magnolia.init.properties.InitPathsPropertySource;
37 import info.magnolia.init.properties.ModulePropertiesSource;
38 import info.magnolia.init.properties.SystemPropertySource;
39 import info.magnolia.module.ModuleRegistry;
40
41 import java.io.IOException;
42 import java.util.ArrayList;
43 import java.util.List;
44
45 import javax.inject.Inject;
46 import javax.inject.Singleton;
47
48 /**
49 * This implementation of {@link MagnoliaConfigurationProperties} sets up the following list of {@link PropertySource}:
50 * <ul>
51 * <li>{@link InitPathsPropertySource}</li>
52 * <li>/mgnl-beans.properties (list of default core components - TODO : this might move to core's module descriptor</li>
53 * <li>{@link ModulePropertiesSource} (all properties exposed my modules)</li>
54 * <li>Sources provided by {@link MagnoliaPropertiesResolver}</li>
55 * <li>{@link SystemPropertySource}</li>
56 * </ul>
57 *
58 * This class along with {@link DefaultMagnoliaPropertiesResolver} provide a replacement for PropertiesInitializer since 4.5.
59 *
60 * @since 4.5
61 *
62 * @author gjoseph
63 * @version $Revision: $ ($Author: $)
64 */
65 @Singleton
66 public class DefaultMagnoliaConfigurationProperties extends AbstractMagnoliaConfigurationProperties {
67
68 private final MagnoliaInitPaths initPaths;
69 private final ModuleRegistry moduleRegistry;
70 private final MagnoliaPropertiesResolver resolver;
71
72 @Inject
73 public DefaultMagnoliaConfigurationProperties(MagnoliaInitPaths initPaths, ModuleRegistry moduleRegistry, MagnoliaPropertiesResolver resolver) {
74 super(null);
75 this.initPaths = initPaths;
76 this.moduleRegistry = moduleRegistry;
77 this.resolver = resolver;
78 }
79
80 @Override
81 public void init() throws Exception {
82 this.sources = makeSources(initPaths, moduleRegistry, resolver);
83 }
84
85 protected static List<PropertySource> makeSources(MagnoliaInitPaths initPaths, ModuleRegistry moduleRegistry, MagnoliaPropertiesResolver resolver) throws IOException {
86 final List<PropertySource> allSources = new ArrayList<PropertySource>();
87 // TODO - this is not correct: we only want OVERRIDING properties here, not all.
88 allSources.add(new SystemPropertySource());
89 final List<PropertySource> configuredSources = resolver.getSources();
90 for (PropertySource source : configuredSources) {
91 allSources.add(source);
92 }
93 allSources.add(new ModulePropertiesSource(moduleRegistry));
94 allSources.add(new InitPathsPropertySource(initPaths));
95
96 // TODO close streams
97 // TODO resolve nested properties - now ?
98 return allSources;
99 }
100 }