Java tutorial
/** * This file Copyright (c) 2003-2012 Magnolia International * Ltd. (http://www.magnolia-cms.com). All rights reserved. * * * This file is dual-licensed under both the Magnolia * Network Agreement and the GNU General Public License. * You may elect to use one or the other of these licenses. * * This file is distributed in the hope that it will be * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the * implied warranty of MERCHANTABILITY or FITNESS FOR A * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. * Redistribution, except as permitted by whichever of the GPL * or MNA you select, is prohibited. * * 1. For the GPL license (GPL), you can redistribute and/or * modify this file under the terms of the GNU General * Public License, Version 3, as published by the Free Software * Foundation. You should have received a copy of the GNU * General Public License, Version 3 along with this program; * if not, write to the Free Software Foundation, Inc., 51 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * 2. For the Magnolia Network Agreement (MNA), this file * and the accompanying materials are made available under the * terms of the MNA which accompanies this distribution, and * is available at http://www.magnolia-cms.com/mna.html * * Any modifications to this file must keep this entire header * intact. * */ package info.magnolia.cms.core; import java.util.ArrayList; import java.util.Map; import java.util.Properties; import info.magnolia.cms.util.DeprecationUtil; import info.magnolia.init.AbstractMagnoliaConfigurationProperties; import info.magnolia.init.MagnoliaConfigurationProperties; import info.magnolia.init.PropertySource; import org.apache.commons.lang.StringUtils; /** * A global holder for system-wide configuration properties. * * @see info.magnolia.cms.beans.config.PropertiesInitializer * * @author Sameer charles * @version 2.0 $Id$ * * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public final class SystemProperty { public static final String MAGNOLIA_REPOSITORIES_HOME = "magnolia.repositories.home"; public static final String MAGNOLIA_REPOSITORIES_CONFIG = "magnolia.repositories.config"; public static final String MAGNOLIA_EXCHANGE_HISTORY = "magnolia.exchange.history"; public static final String MAGNOLIA_UPLOAD_TMPDIR = "magnolia.upload.tmpdir"; public static final String MAGNOLIA_CACHE_STARTDIR = "magnolia.cache.startdir"; public static final String MAGNOLIA_APP_ROOTDIR = "magnolia.app.rootdir"; public static final String MAGNOLIA_BOOTSTRAP_ROOTDIR = "magnolia.bootstrap.dir"; public static final String MAGNOLIA_BOOTSTRAP_SAMPLES = "magnolia.bootstrap.samples"; public static final String MAGNOLIA_UTF8_ENABLED = "magnolia.utf8.enabled"; public static final String MAGNOLIA_WEBAPP = "magnolia.webapp"; public static final String MAGNOLIA_SERVERNAME = "magnolia.servername"; public static final String MAGNOLIA_CONTEXTPATH = "magnolia.contextpath"; private static Properties properties = new Properties(); /** * Utility class, don't instantiate. */ private SystemProperty() { // unused } /** * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public static void setProperty(String name, String value) { // DeprecationUtil.isDeprecated(); properties.put(name, value); } /** * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public static String getProperty(String name) { final String legacy = (String) properties.get(name); if (legacy != null) { // DeprecationUtil.isDeprecated("Property [" + name + "] was found with value ["+legacy+"] in the legacy Properties field of SystemProperty. Please consider using MagnoliaConfigurationProperties instead."); return legacy; } return getMagnoliaConfigurationProperties().getProperty(name); } /** * Returns a boolean property, returning <code>false</code> if the property is not set. * @param name property name * @return true only if the request property has a value of <code>true</code> * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public static boolean getBooleanProperty(String name) { return "true".equals(getProperty(name)); } /** * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public static String getProperty(String name, String defaultValue) { String value = getProperty(name); if (StringUtils.isEmpty(value)) { return defaultValue; } return value; } /** * @deprecated since 4.5, use {@link info.magnolia.init.MagnoliaConfigurationProperties} */ public static boolean hasProperty(String name) { final boolean legacy = properties.containsKey(name); if (legacy) { DeprecationUtil.isDeprecated("Property [" + name + "] was found in the legacy Properties field of SystemProperty. Please consider using MagnoliaConfigurationProperties instead."); return legacy; } return getMagnoliaConfigurationProperties().hasProperty(name); } /** * @deprecated since 3.0 - use getProperties() instead */ public static Map getPropertyList() { return properties; } /** * @deprecated since 4.5 - while this still "works" and returns an aggregate of the local properties and those provided by * MagnoliaConfigurationProperties, writing to this Property object will not be reflected anywhere. */ public static Properties getProperties() { // DeprecationUtil.isDeprecated(); // providing a MagnoliaConfigurationProperties-compliant replacement... final Properties p = new Properties(); p.putAll(properties); for (String k : magnoliaConfigurationProperties.getKeys()) { p.put(k, magnoliaConfigurationProperties.getProperty(k)); } return p; } static MagnoliaConfigurationProperties magnoliaConfigurationProperties = new AbstractMagnoliaConfigurationProperties( new ArrayList<PropertySource>()) { }; private static MagnoliaConfigurationProperties getMagnoliaConfigurationProperties() { // can't do Components.getComponent(MagnoliaConfigurationProperties.class) because this currently gets used before Components is ready. return magnoliaConfigurationProperties; } /** * @deprecated since 4.5 - this is only here to allow tests to work until their tested classes are all converted. */ public static void setMagnoliaConfigurationProperties( MagnoliaConfigurationProperties magnoliaConfigurationProperties) { SystemProperty.magnoliaConfigurationProperties = magnoliaConfigurationProperties; } /** * @since 4.5 needed to clear up the hacks above, in tests. */ public static void clear() { properties.clear(); // magnoliaConfigurationProperties = null; } }