View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.cms.core;
35  
36  import info.magnolia.cms.util.DeprecationUtil;
37  import info.magnolia.init.AbstractMagnoliaConfigurationProperties;
38  import info.magnolia.init.MagnoliaConfigurationProperties;
39  import info.magnolia.init.PropertySource;
40  
41  import java.util.ArrayList;
42  import java.util.Properties;
43  
44  import org.apache.commons.lang3.StringUtils;
45  
46  
47  /**
48   * A global holder for system-wide configuration properties.
49   *
50   * @see info.magnolia.cms.beans.config.PropertiesInitializer
51   * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
52   */
53  public final class SystemProperty {
54  
55      public static final String MAGNOLIA_REPOSITORIES_HOME = MagnoliaConfigurationProperties.MAGNOLIA_REPOSITORIES_HOME;
56  
57      public static final String MAGNOLIA_REPOSITORIES_CONFIG = MagnoliaConfigurationProperties.MAGNOLIA_REPOSITORIES_CONFIG;
58  
59      public static final String MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG = MagnoliaConfigurationProperties.MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG;
60  
61      public static final String MAGNOLIA_REPOSITORIES_CLUSTER_MASTER = MagnoliaConfigurationProperties.MAGNOLIA_REPOSITORIES_CLUSTER_MASTER;
62  
63      public static final String MAGNOLIA_EXCHANGE_HISTORY = MagnoliaConfigurationProperties.MAGNOLIA_EXCHANGE_HISTORY;
64  
65      public static final String MAGNOLIA_UPLOAD_TMPDIR = MagnoliaConfigurationProperties.MAGNOLIA_UPLOAD_TMPDIR;
66  
67      public static final String MAGNOLIA_CACHE_STARTDIR = MagnoliaConfigurationProperties.MAGNOLIA_CACHE_STARTDIR;
68  
69      public static final String MAGNOLIA_APP_ROOTDIR = MagnoliaConfigurationProperties.MAGNOLIA_APP_ROOTDIR;
70  
71      public static final String MAGNOLIA_BOOTSTRAP_ROOTDIR = MagnoliaConfigurationProperties.MAGNOLIA_BOOTSTRAP_ROOTDIR;
72  
73      public static final String MAGNOLIA_BOOTSTRAP_SAMPLES = MagnoliaConfigurationProperties.MAGNOLIA_BOOTSTRAP_SAMPLES;
74  
75      public static final String MAGNOLIA_UTF8_ENABLED = MagnoliaConfigurationProperties.MAGNOLIA_UTF8_ENABLED;
76  
77      public static final String MAGNOLIA_WEBAPP = MagnoliaConfigurationProperties.MAGNOLIA_WEBAPP;
78  
79      public static final String MAGNOLIA_SERVERNAME = MagnoliaConfigurationProperties.MAGNOLIA_SERVERNAME;
80  
81      public static final String MAGNOLIA_CONTEXTPATH = MagnoliaConfigurationProperties.MAGNOLIA_CONTEXTPATH;
82  
83      private static Properties properties = new Properties();
84      private static MagnoliaConfigurationProperties magnoliaConfigurationProperties = newMagnoliaConfigurationProperties();
85  
86      /**
87       * Utility class, don't instantiate.
88       */
89      private SystemProperty() {
90          // unused
91      }
92  
93      /**
94       * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
95       */
96      public static void setProperty(String name, String value) {
97          // DeprecationUtil.isDeprecated();
98          properties.put(name, value);
99      }
100 
101     /**
102      * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
103      */
104     public static String getProperty(String name) {
105         final String legacy = (String) properties.get(name);
106         if (legacy != null) {
107             // DeprecationUtil.isDeprecated("Property [" + name + "] was found with value ["+legacy+"] in the legacy Properties field of SystemProperty. Please consider using MagnoliaConfigurationProperties instead.");
108             return legacy;
109         }
110         return getMagnoliaConfigurationProperties().getProperty(name);
111     }
112 
113     /**
114      * Returns a boolean property, returning <code>false</code> if the property is not set.
115      *
116      * @param name property name
117      * @return true only if the request property has a value of <code>true</code>
118      * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
119      */
120     public static boolean getBooleanProperty(String name) {
121         return "true".equals(getProperty(name));
122     }
123 
124     /**
125      * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
126      */
127     public static String getProperty(String name, String defaultValue) {
128         String value = getProperty(name);
129         if (StringUtils.isEmpty(value)) {
130             return defaultValue;
131         }
132         return value;
133     }
134 
135     /**
136      * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties}
137      */
138     public static boolean hasProperty(String name) {
139         final boolean legacy = properties.containsKey(name);
140         if (legacy) {
141             DeprecationUtil.isDeprecated("Property [" + name + "] was found in the legacy Properties field of SystemProperty. Please consider using MagnoliaConfigurationProperties instead.");
142             return legacy;
143         }
144         return getMagnoliaConfigurationProperties().hasProperty(name);
145     }
146 
147     /**
148      * @deprecated since 4.5 - while this still "works" and returns an aggregate of the local properties and those provided by
149      *             MagnoliaConfigurationProperties, writing to this Property object will not be reflected anywhere.
150      */
151     public static Properties getProperties() {
152         // DeprecationUtil.isDeprecated();
153         // providing a MagnoliaConfigurationProperties-compliant replacement...
154         final Properties p = new Properties();
155         p.putAll(properties);
156         for (String k : magnoliaConfigurationProperties.getKeys()) {
157             p.put(k, magnoliaConfigurationProperties.getProperty(k));
158         }
159         return p;
160     }
161 
162     private static MagnoliaConfigurationProperties getMagnoliaConfigurationProperties() {
163         // can't do Components.getComponent(MagnoliaConfigurationProperties.class) because this currently gets used before Components is ready.
164         return magnoliaConfigurationProperties;
165     }
166 
167     /**
168      * @deprecated since 4.5 - this is only here to allow tests to work until their tested classes are all converted.
169      */
170     public static void setMagnoliaConfigurationProperties(MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
171         SystemProperty.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
172     }
173 
174     /**
175      * @since 4.5 needed to clear up the hacks above, in tests.
176      */
177     public static void clear() {
178         properties.clear();
179         magnoliaConfigurationProperties = newMagnoliaConfigurationProperties();
180     }
181 
182     private static AbstractMagnoliaConfigurationProperties newMagnoliaConfigurationProperties() {
183         return new AbstractMagnoliaConfigurationProperties(new ArrayList<PropertySource>()) {
184         };
185     }
186 
187 }