org.eurekaclinical.standardapis.props.EurekaClinicalProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eurekaclinical-standard-apis Show documentation
Show all versions of eurekaclinical-standard-apis Show documentation
A library of classes shared across the Eureka! Clinical platform.
package org.eurekaclinical.standardapis.props;
/*-
* #%L
* Eureka! Clinical Standard APIs
* %%
* Copyright (C) 2016 Emory University
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* @author hrathod
*/
public abstract class EurekaClinicalProperties {
/**
* The class level logger.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(EurekaClinicalProperties.class);
/**
* Name of the system property containing a pathname to the configuration
* file.
*/
private static final String CONFIG_DIR_SYS_PROP = "eureka.config.dir";
private static final String PROPERTIES_FILENAME = "application.properties";
/**
* Fallback properties file for application configuration as a resource.
*/
private static final String FALLBACK_CONFIG_FILE = '/' + PROPERTIES_FILENAME;
/**
* Holds an instance of the properties object which contains all the
* application configuration properties.
*/
private final Properties properties;
private String configDir;
/**
* Loads the application configuration.
*
* There are two potential sources of application configuration. The
* fallback configuration should always be there. The default configuration
* directory, provided as an argument to this constructor, may optionally
* have an application.properties file within it that overrides the fallback
* configuration for each configuration property that is specified. The
* eureka.config.dir system property allows specifying an
* alternative configuration directory.
*
* @param defaultConfigDir the default location of configuration file, based
* on the operating system. Cannot be null.
*/
protected EurekaClinicalProperties(String defaultConfigDir) {
if (defaultConfigDir == null) {
throw new IllegalArgumentException("defaultConfigDir cannot be null");
}
this.properties = new Properties();
try (InputStream inputStream = getClass().getResourceAsStream(FALLBACK_CONFIG_FILE)) {
if (inputStream != null) {
this.properties.load(inputStream);
}
} catch (IOException ioe) {
throw new AssertionError("Fallback configuration is unavailable: " + ioe.getMessage());
}
this.configDir = System.getProperty(CONFIG_DIR_SYS_PROP);
if (this.configDir == null) {
this.configDir = defaultConfigDir;
}
if (this.configDir == null) {
throw new AssertionError("eureka.config.dir not specified in " + FALLBACK_CONFIG_FILE);
}
this.properties.remove(CONFIG_DIR_SYS_PROP);
File configFile = new File(this.configDir, PROPERTIES_FILENAME);
if (configFile.exists()) {
LOGGER.info("Trying to load default configuration from {}",
configFile.getAbsolutePath());
try (InputStream inputStream = new FileInputStream(configFile)) {
this.properties.load(inputStream);
} catch (IOException ex) {
LOGGER.error("Error reading application.properties file {}: {}. "
+ "Built-in defaults will be used, some "
+ "of which are unlikely to be what you want.",
configFile.getAbsolutePath(), ex.getMessage());
}
} else {
LOGGER.warn("No configuration file found at {}. "
+ "Built-in defaults will be used, some "
+ "of which are unlikely to be what you want.",
configFile.getAbsolutePath());
}
}
public String getConfigDir() {
return configDir;
}
public String getStage() {
return this.getValue("eurekaclinical.stage", "DEVELOPMENT");
}
/**
* A URL representing the domain in which Eureka Clinical is installed.
*
* @return a URL string.
*/
public String getDomainUrl() {
return getValue("eurekaclinical.domain.url", "https://localhost");
}
public abstract String getUrl();
/**
* Returns the String value of the given property name.
*
* @param propertyName The property name to fetch the value for.
* @return A String containing the value of the given property name, or null
* if the property name does not exist.
*/
protected final String getValue(final String propertyName) {
/*
* Don't use this.properties.containsKey(). It doesn't work with the
* built-in default value mechanism. Also, the semantics of a
* Properties list are such that a null property value is the same
* as never specified in the list.
*/
return this.properties.getProperty(propertyName);
}
/**
* Returns the String value of the given property name, or the given default
* if the given property name does not exist.
*
* @param propertyName The name of the property to fetch a value for.
* @param defaultValue The default value to return if the property name does
* not exist.
* @return A string containing either the value of the property, or the
* default value.
*/
protected final String getValue(final String propertyName, String defaultValue) {
String value = getValue(propertyName);
if (value == null) {
if (defaultValue == null) {
LOGGER.warn(
"Property '{}' is not specified in "
+ getClass().getName()
+ ", and no default is specified.", propertyName);
}
value = defaultValue;
}
return value;
}
/**
* Reads in a property value as a whitespace-delimited list of items.
*
* @param inPropertyName The name of the property to read.
* @return A list containing the items in the value, or null if
* the property is not found.
*/
protected final List getStringListValue(final String inPropertyName) {
List result = null;
String value = this.properties.getProperty(inPropertyName);
if (value != null) {
String[] temp = value.split("\\s+");
result = new ArrayList<>(temp.length);
for (String s : temp) {
String trimmed = s.trim();
if (trimmed.length() > 0) {
result.add(s.trim());
}
}
}
return result;
}
/**
* Reads in a property value as a whitespace-delimited list of items.
*
* @param inPropertyName The name of the property to read.
* @param defaultValue The value to return if the property is not found.
* @return A list containing the items in the value.
*/
protected final List getStringListValue(final String inPropertyName,
List defaultValue) {
List result = getStringListValue(inPropertyName);
if (result == null) {
LOGGER.warn("Property not found in configuration: {}",
inPropertyName);
result = defaultValue;
}
return result;
}
/**
* Utility method to get an int from the properties file.
*
* @param propertyName The name of the property.
* @param defaultValue The default value to return, if the property is not
* found, or is malformed.
* @return The property value, as an int.
*/
protected final int getIntValue(final String propertyName, int defaultValue) {
int result;
String property = this.properties.getProperty(propertyName);
try {
result = Integer.parseInt(property);
} catch (NumberFormatException e) {
LOGGER.warn("Invalid integer property in configuration: {}",
propertyName);
result = defaultValue;
}
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy