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.objectfactory.guice;
35
36 import info.magnolia.init.MagnoliaConfigurationProperties;
37 import info.magnolia.objectfactory.Components;
38 import info.magnolia.objectfactory.NoSuchComponentException;
39
40 import com.google.inject.Key;
41
42 /**
43 * Guice configuration module which exposes Magnolia properties.
44 */
45 public class GuicePropertyConfigurer extends AbstractGuiceComponentConfigurer {
46
47 @Override
48 protected void configure() {
49
50 // If we have a parent and it has a MagnoliaConfigurationProperties component expose all its properties
51 if (parentComponentProvider != null) {
52 try {
53 MagnoliaConfigurationProperties configurationProperties = parentComponentProvider.getComponent(MagnoliaConfigurationProperties.class);
54 installProperties(configurationProperties);
55 } catch (NoSuchComponentException e) {
56 // happens if the MagnoliaConfigurationProperties isn't registered
57 // this is the case in tests
58 }
59 }
60 }
61
62 private void installProperties(MagnoliaConfigurationProperties configurationProperties) {
63
64 for (final String key : configurationProperties.getKeys()) {
65
66 /*
67 Unfortunately there's a trade off here. We CAN register these as providers, then properties can change
68 and we can get the changed values using a provider. But then we dont get conversion to primitives such as
69 boolean and int.
70 */
71
72 /*
73 binder().bind(Key.get(String.class, new NamedImpl(propertyName))).toProvider(new Provider<String>() {
74 @Override
75 public String get() {
76 return SystemProperty.getProperty(configurationProperties.getProperty(key));
77 }
78 });
79 */
80 binder().bind(Key.get(String.class, Components.named(key))).toInstance(configurationProperties.getProperty(key));
81 }
82 }
83
84 /**
85 * Represents an instantiated @Named annotation.
86 *
87 * @deprecated since 5.5.5 - use {@link info.magnolia.objectfactory.Components#named(String)} instead.
88 */
89 @Deprecated
90 public static class NamedImpl extends info.magnolia.objectfactory.NamedImpl {
91
92 public NamedImpl(String value) {
93 super(value);
94 }
95 }
96 }