36872660172

Committed 01 Oct 2026 01:58PM UTC coverage: 66.293% (+0.2%) from 66.046%

Build # 36872660172

Build Type

push

github

Committed by

ibacher

Commit Message

TRUNK-6707: Implement full caching for Global Properties (#6598)

Coverage Stats

219 of 229 new or added lines in 7 files covered. (95.63%)

1 existing line in 1 file now uncovered.

25757 of 38853 relevant lines covered (66.29%)

0.66 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.74

/api/src/main/java/org/openmrs/util/ConfigUtil.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.util;

import org.apache.commons.lang3.StringUtils;
import org.openmrs.api.context.Context;

/**
 * A utility class for working with configuration properties
 */
public class ConfigUtil {
        
        /**
         * Gets the value of the given OpenMRS global property
         */
        public static String getGlobalProperty(String propertyName) {
                return Context.getAdministrationService().getGlobalProperty(propertyName);
        }
        
        /**
         * Returns the value of the given OpenMRS runtime property
         */
        public static String getRuntimeProperty(String propertyName) {
                return Context.getRuntimeProperties().getProperty(propertyName);
        }
        
        /**
         * Returns true if a runtime property with the given name has been defined, even if the value is empty
         */
        public static boolean hasRuntimeProperty(String propertyName) {
                return Context.getRuntimeProperties().containsKey(propertyName);
        }
        
        /**
         * Returns the value of the given OpenMRS system property
         */
        public static String getSystemProperty(String propertyName) {
                return System.getProperty(propertyName);
        }
        
        /**
         * Returns true if a system property with the given name has been defined, even if the value is empty
         */
        public static boolean hasSystemProperty(String propertyName) {
                return System.getProperties().containsKey(propertyName);
        }
        
        /**
         * Returns the value of the given configuration property.  This will check the OpenMRS global properties,
         * OpenMRS runtime properties, and any defined system properties.  In the event that a property is defined in 
         * multiple places, the order of precedence is system properties, then runtime properties, then global properties
         */
        public static String getProperty(String propertyName) {
                if (hasSystemProperty(propertyName)) {
                        return getSystemProperty(propertyName);
                }
                if (hasRuntimeProperty(propertyName)) {
                        return getRuntimeProperty(propertyName);
                }
                return getGlobalProperty(propertyName);
        }
        
        /**
         * Returns the value of the given configuration property.  This will check the OpenMRS global properties,
         * OpenMRS runtime properties, and any defined system properties.  In the event that a property is defined in 
         * multiple places, the order of precedence is system properties, then runtime properties, then global properties
         * If the value found is null, empty, or only whitespace, then the default value is returned
         */
        public static String getProperty(String propertyName, String defaultValue) {
                String value = getProperty(propertyName);
                if (StringUtils.isBlank(value)) {
                        value = defaultValue;
                }
                return value;
        }
        
        /**
         * Operates as above but returns the Boolean value of the property
         * 
         * @param propertyName
         * @param defaultValue
         * @return
         */
        public static boolean getProperty(String propertyName, boolean defaultValue) {
                String value = getProperty(propertyName);
                if (StringUtils.isBlank(value)) {
                        return defaultValue;
                }
                return Boolean.parseBoolean(value);
        }
}

1	/**
2	* This Source Code Form is subject to the terms of the Mozilla Public License,
3	* v. 2.0. If a copy of the MPL was not distributed with this file, You can
4	* obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
5	* the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
6	*
7	* Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
8	* graphic logo is a trademark of OpenMRS Inc.
9	*/
10	package org.openmrs.util;
11
12	import org.apache.commons.lang3.StringUtils;
13	import org.openmrs.api.context.Context;
14
15	/**
16	* A utility class for working with configuration properties
17	*/
NEW 18	public class ConfigUtil {	×
19
20	/**
21	* Gets the value of the given OpenMRS global property
22	*/
23	public static String getGlobalProperty(String propertyName) {
24	return Context.getAdministrationService().getGlobalProperty(propertyName);	1 ✔
25	}
26
27	/**
28	* Returns the value of the given OpenMRS runtime property
29	*/
30	public static String getRuntimeProperty(String propertyName) {
31	return Context.getRuntimeProperties().getProperty(propertyName);	1 ✔
32	}
33
34	/**
35	* Returns true if a runtime property with the given name has been defined, even if the value is empty
36	*/
37	public static boolean hasRuntimeProperty(String propertyName) {
38	return Context.getRuntimeProperties().containsKey(propertyName);	1 ✔
39	}
40
41	/**
42	* Returns the value of the given OpenMRS system property
43	*/
44	public static String getSystemProperty(String propertyName) {
45	return System.getProperty(propertyName);	1 ✔
46	}
47
48	/**
49	* Returns true if a system property with the given name has been defined, even if the value is empty
50	*/
51	public static boolean hasSystemProperty(String propertyName) {
52	return System.getProperties().containsKey(propertyName);	1 ✔
53	}
54
55	/**
56	* Returns the value of the given configuration property. This will check the OpenMRS global properties,
57	* OpenMRS runtime properties, and any defined system properties. In the event that a property is defined in
58	* multiple places, the order of precedence is system properties, then runtime properties, then global properties
59	*/
60	public static String getProperty(String propertyName) {
61	if (hasSystemProperty(propertyName)) {	1 ✔
62	return getSystemProperty(propertyName);	1 ✔
63	}
64	if (hasRuntimeProperty(propertyName)) {	1 ✔
65	return getRuntimeProperty(propertyName);	1 ✔
66	}
67	return getGlobalProperty(propertyName);	1 ✔
68	}
69
70	/**
71	* Returns the value of the given configuration property. This will check the OpenMRS global properties,
72	* OpenMRS runtime properties, and any defined system properties. In the event that a property is defined in
73	* multiple places, the order of precedence is system properties, then runtime properties, then global properties
74	* If the value found is null, empty, or only whitespace, then the default value is returned
75	*/
76	public static String getProperty(String propertyName, String defaultValue) {
77	String value = getProperty(propertyName);	1 ✔
78	if (StringUtils.isBlank(value)) {	1 ✔
79	value = defaultValue;	1 ✔
80	}
81	return value;	1 ✔
82	}
83
84	/**
85	* Operates as above but returns the Boolean value of the property
86	*
87	* @param propertyName
88	* @param defaultValue
89	* @return
90	*/
91	public static boolean getProperty(String propertyName, boolean defaultValue) {
92	String value = getProperty(propertyName);	1 ✔
93	if (StringUtils.isBlank(value)) {	1 ✔
94	return defaultValue;	1 ✔
95	}
96	return Boolean.parseBoolean(value);	1 ✔
97	}
98	}

openmrs / openmrs-core / 36872660172

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous