View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.init;
35  
36  import static info.magnolia.objectfactory.Components.getComponent;
37  
38  import info.magnolia.init.properties.EnvironmentPropertySource;
39  import info.magnolia.init.properties.InitPathsPropertySource;
40  import info.magnolia.init.properties.ModulePropertiesSource;
41  import info.magnolia.init.properties.SystemPropertySource;
42  import info.magnolia.module.ModuleRegistry;
43  
44  import java.io.IOException;
45  import java.util.Collections;
46  import java.util.List;
47  
48  import javax.inject.Inject;
49  import javax.inject.Singleton;
50  
51  /**
52   * This implementation of {@link MagnoliaConfigurationProperties} sets up the following list of {@link PropertySource}:
53   * <ul>
54   * <li>{@link InitPathsPropertySource}</li>
55   * <li>{@link ModulePropertiesSource} (all properties exposed my modules)</li>
56   * <li>Sources provided by {@link MagnoliaPropertiesResolver}</li>
57   * <li>{@link SystemPropertySource}</li>
58   * <li>{@link EnvironmentPropertySource}</li>
59   * </ul>
60   *
61   * This class along with {@link DefaultMagnoliaPropertiesResolver} provide a replacement for PropertiesInitializer since 4.5.
62   *
63   * @since 4.5
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      private final SystemPropertySource systemPropertySource;
72      private final EnvironmentPropertySource environmentPropertySource;
73  
74      @Inject
75      public DefaultMagnoliaConfigurationProperties(MagnoliaInitPaths initPaths, ModuleRegistry moduleRegistry, MagnoliaPropertiesResolver resolver, SystemPropertySource systemPropertySource, EnvironmentPropertySource environmentPropertySource) {
76          this.initPaths = initPaths;
77          this.moduleRegistry = moduleRegistry;
78          this.resolver = resolver;
79          this.systemPropertySource = systemPropertySource;
80          this.environmentPropertySource = environmentPropertySource;
81      }
82  
83      /**
84       * @deprecated  use {@link #DefaultMagnoliaConfigurationProperties(MagnoliaInitPaths, ModuleRegistry, MagnoliaPropertiesResolver, SystemPropertySource, EnvironmentPropertySource)} instead.
85       */
86      @Deprecated
87      public DefaultMagnoliaConfigurationProperties(MagnoliaInitPaths initPaths, ModuleRegistry moduleRegistry, MagnoliaPropertiesResolver resolver) {
88          this(initPaths, moduleRegistry, resolver, getComponent(SystemPropertySource.class), getComponent(EnvironmentPropertySource.class));
89      }
90  
91      @Override
92      public void init() throws Exception {
93          sources.add(systemPropertySource);
94          sources.add(environmentPropertySource);
95          final List<PropertySource> configuredSources = resolver.getSources();
96          for (PropertySource source : configuredSources) {
97              sources.add(source);
98          }
99          sources.add(new ModulePropertiesSource(moduleRegistry));
100         sources.add(new InitPathsPropertySource(initPaths));
101     }
102 
103     /**
104      * @deprecated since 5.4.7, without replacement.
105      */
106     @Deprecated
107     protected static List<PropertySource> makeSources(MagnoliaInitPaths initPaths, ModuleRegistry moduleRegistry, MagnoliaPropertiesResolver resolver) throws IOException {
108         return Collections.emptyList();
109     }
110 }