1 /**
2 * This file Copyright (c) 2011-2014 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 java.io.Serializable;
37 import java.lang.annotation.Annotation;
38 import javax.inject.Named;
39
40 import com.google.inject.Key;
41 import info.magnolia.init.MagnoliaConfigurationProperties;
42 import info.magnolia.objectfactory.NoSuchComponentException;
43
44 /**
45 * Guice configuration module which exposes Magnolia properties.
46 *
47 * @version $Id$
48 */
49 public class GuicePropertyConfigurer extends AbstractGuiceComponentConfigurer {
50
51 @Override
52 protected void configure() {
53
54 // If we have a parent and it has a MagnoliaConfigurationProperties component expose all its properties
55 if (parentComponentProvider != null) {
56 try{
57 MagnoliaConfigurationProperties configurationProperties = parentComponentProvider.getComponent(MagnoliaConfigurationProperties.class);
58 installProperties(configurationProperties);
59 }
60 catch(NoSuchComponentException e){
61 // happens if the MagnoliaConfigurationProperties isn't registered
62 // this is the case in tests
63 }
64 }
65 }
66
67 private void installProperties(MagnoliaConfigurationProperties configurationProperties) {
68
69 for (final String key : configurationProperties.getKeys()) {
70
71 /*
72 Unfortunately there's a trade off here. We CAN register these as providers, then properties can change
73 and we can get the changed values using a provider. But then we dont get conversion to primitives such as
74 boolean and int.
75 */
76
77 /*
78 binder().bind(Key.get(String.class, new NamedImpl(propertyName))).toProvider(new Provider<String>() {
79 @Override
80 public String get() {
81 return SystemProperty.getProperty(configurationProperties.getProperty(key));
82 }
83 });
84 */
85 binder().bind(Key.get(String.class, new NamedImpl(key))).toInstance(configurationProperties.getProperty(key));
86 }
87 }
88
89 /**
90 * Represents an instantiated @Named annotation.
91 */
92 public static class NamedImpl implements Named, Serializable {
93
94 private static final long serialVersionUID = 0;
95
96 private final String value;
97
98 public NamedImpl(String value) {
99 this.value = value;
100 }
101
102 @Override
103 public String value() {
104 return this.value;
105 }
106
107 @Override
108 public int hashCode() {
109 // This is specified in java.lang.Annotation.
110 return (127 * "value".hashCode()) ^ value.hashCode();
111 }
112
113 @Override
114 public boolean equals(Object o) {
115 if (!(o instanceof Named)) {
116 return false;
117 }
118
119 Named other = (Named) o;
120 return value.equals(other.value());
121 }
122
123 @Override
124 public String toString() {
125 return "@" + Named.class.getName() + "(value=" + value + ")";
126 }
127
128 @Override
129 public Class<? extends Annotation> annotationType() {
130 return Named.class;
131 }
132 }
133 }