com.cisco.oss.foundation.configuration.ConfigUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of configuration-api Show documentation
Show all versions of configuration-api Show documentation
This project is the api library for configuration in the cisco vss foundation runtime
/*
* Copyright 2014 Cisco Systems, Inc.
*
* 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.
*/
package com.cisco.oss.foundation.configuration;
import com.cisco.oss.foundation.environment.utils.EnvUtils;
import org.apache.commons.configuration.CompositeConfiguration;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.HierarchicalConfiguration;
import java.io.InputStream;
import java.lang.reflect.Array;
import java.net.URISyntaxException;
import java.net.URL;
import java.text.DecimalFormatSymbols;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.regex.Pattern;
/**
* Simple utility class useful for handling the common configuration framework.
*
* @author Joel Gurfinkel
*
*/
public final class ConfigUtil {
// hexadecimal string regular expression
private final static Pattern HEX_REGEX_PATTERN = Pattern.compile("^[A-Fa-f0-9]+$");
private final static char DECIMAL_SEP = DecimalFormatSymbols.getInstance().getDecimalSeparator();
private ConfigUtil() {
// prevent instantiation.
}
/**
* returns the hierarchical part of a configuration
*
* @param configuration
* the given configuration
* @return the hierarchical configuration or null if not found in the given
* configuration object.
*/
public static HierarchicalConfiguration getHierarchicalConfiguration(final Configuration configuration) {
if (configuration instanceof CompositeConfiguration) {
final CompositeConfiguration compositeConfig = (CompositeConfiguration) configuration;
for (int i = 0; i < compositeConfig.getNumberOfConfigurations(); i++) {
if (compositeConfig.getConfiguration(i) instanceof HierarchicalConfiguration) {
return (HierarchicalConfiguration) compositeConfig.getConfiguration(i);
}
}
}
// maybe I need to send a runtime exception ??
// throw new
// ConfigurationRuntimeException("no hierarchical configuration was defined");
return null;
}
/**
* create a composite configuration that wraps the configuration sent by the
* user. this util will also load the "defaultConfig.properties" file loaded
* relative to the given "clazz" parameter
*
* @param clazz
* - the class that acts as referenced location of
* "defaultConfig.properties".
* @param configuration
* - the configuration supplied by the user that may override
* values in "defaultConfig.properties". If null is ignored.
* @return the created compsite configuration.
*/
public static Configuration createCompositeConfiguration(final Class clazz, final Configuration configuration) {
final CompositeConfiguration compositeConfiguration = new CompositeConfiguration();
final Configuration defaultConfiguration = ConfigurationFactory.getDefaultConfiguration();
if (configuration != null) {
compositeConfiguration.addConfiguration(configuration);
}
compositeConfiguration.addConfiguration(defaultConfiguration);
return compositeConfiguration;
}
public static void enableCcp(String componentName, String componentVersion, String installPath, String compoentHostName, String ccpServerHostName) {
enableCcp(componentName, componentVersion, installPath, compoentHostName, ccpServerHostName, 5670);
}
public static void enableCcp(String componentName, String componentVersion, String installPath, String compoentHostName, String ccpServerHostName, int ccpServerPort) {
EnvUtils.updateEnv(CcpConstants.CCP_ENABLED, "true");
EnvUtils.updateEnv(CcpConstants.FQDN, compoentHostName);
EnvUtils.updateEnv(CcpConstants.RPM_SOFTWARE_NAME, compoentHostName);
EnvUtils.updateEnv(CcpConstants.ARTIFACT_VERSION, componentVersion);
EnvUtils.updateEnv(CcpConstants.INSTALL_DIR, installPath);
EnvUtils.updateEnv(CcpConstants.CCP_SERVER, ccpServerHostName + ":" + ccpServerPort);
}
public static void disableCcp() {
EnvUtils.updateEnv(CcpConstants.CCP_ENABLED, "false");
}
/**
* Parse a complex array structure and return it as a map containing maps as
* values for further internal structures
* Example of configuration we support:
* smartcardAdaptor.cardFeatures.1.cardFamily=VGE
* smartcardAdaptor.cardFeatures.1.supportSbm=true
* smartcardAdaptor.cardFeatures.1.maxSbmBlocks=16
* smartcardAdaptor.cardFeatures.1.sbmMSB.0=0x00
* smartcardAdaptor.cardFeatures.1.sbmMSB.1=0x01
* smartcardAdaptor.cardFeatures.1.maxRegions=4
* smartcardAdaptor.cardFeatures.1.initialCounter=1000
* smartcardAdaptor.cardFeatures.1.maxNumOfOPPVs=25
*
* smartcardAdaptor.cardFeatures.23.cardFamily=VGE
* smartcardAdaptor.cardFeatures.23.supportSbm=true
* smartcardAdaptor.cardFeatures.23.maxSbmBlocks=16
* smartcardAdaptor.cardFeatures.23.sbmMSB.0=0x00
* smartcardAdaptor.cardFeatures.23.sbmMSB.1=0x01
* smartcardAdaptor.cardFeatures.23.maxRegions=4
* smartcardAdaptor.cardFeatures.23.initialCounter=1000
* smartcardAdaptor.cardFeatures.23.maxNumOfOPPVs=25
*
*
* Will return a map where key is 1, 23 and values are the key/value pairs
* the follow the key.
* E.g Map - key = 1, value= Map(cardFamily -> VGE, supportSbm ->true) etc.
*/
public static Map> parseComplexArrayStructure(String configPrefix) {
Configuration configuration = ConfigurationFactory.getConfiguration();
Map> result = new HashMap>();
// get a subset of the configuration based on the config prefix.
final Configuration subset = configuration.subset(configPrefix);
@SuppressWarnings("unchecked")
final Iterator keys = subset.getKeys();
while (keys.hasNext()) {
final String key = keys.next();
final String mapKey = stripKey(key);
// only if the map key is not null and contains the above saved
// criteria key do we want to handle this.
if (mapKey != null) {
// first time only - create the inner map instance
if (!result.containsKey(mapKey)) {
result.put(mapKey, new HashMap());
}
// get the inner map key value.
final String innerMapKey = getInnerMapKey(key);
// update the reply map format.
result.get(mapKey).put(innerMapKey, subset.getString(key));
}
}
return result;
}
/**
* parse an simple array and return it as a Map. Can be used in conjunction with {@code ConfigUtil#parseComplexArrayStructure(String)}
* @param configPrefix the prefix that is the basis of the array. E.g.
*
* given:
*
* smartcardAdaptor.cardFeatures.23.sbmMSB.0=0x00
* smartcardAdaptor.cardFeatures.23.sbmMSB.1=0x01
*
* the config prefix will be:
* smartcardAdaptor.cardFeatures.23.sbmMSB
*
* @return the Map where the index is the key and the value is the value.
*/
public static Map parseSimpleArrayAsMap(String configPrefix) {
Configuration configuration = ConfigurationFactory.getConfiguration();
return parseSimpleArrayAsMap(configuration, configPrefix);
}
public static Map parseSimpleArrayAsMap(Configuration configuration, String configPrefix) {
Map result = new HashMap();
// get a subset of the configuration based on the config prefix.
final Configuration subset = configuration.subset(configPrefix);
@SuppressWarnings("unchecked")
final Iterator keys = subset.getKeys();
while (keys.hasNext()) {
final String key = keys.next();
result.put(key, subset.getString(key));
}
return result;
}
/**
* create inner key map by taking what ever is after the first dot.
*
* @param key
* @return
*/
private static String getInnerMapKey(final String key) {
final int index = key.indexOf(".");
return key.substring(index + 1);
}
/**
* strip the original key by taking every thing from the start of the
* original key to the first dot.
*
* @param key
* @return
*/
private static String stripKey(final String key) {
int index = key.indexOf(".");
if (index > 0) {
return key.substring(0, index);
}
return null;
}
public static boolean isNumeric(String value) {
return isNumeric(value, 0, -1);
}
public static boolean isNumeric(String value, int startIndex, int endIndex) {
if (value == null) {
return false;
}
if (endIndex <0) {
endIndex = value.length();
}
boolean hadDecimalSep = false;
for (int i=startIndex; i 0 || endIndex < value.length()) {
value = value.substring(startIndex, endIndex);
}
try {
Double dbl = Double.parseDouble(value);
if (dbl.isNaN()) {
return null;
}
return dbl;
} catch (NumberFormatException ex) {
return null;
}
}
//==================================================================================================================
public static boolean equalValues(Object o1, Object o2) {
if (o1 == o2) {
return true;
}
if (o1 == null || o2 == null) {
return false;
}
return o1.equals(o2);
}
//==================================================================================================================
public static URL getResource(String fileName) {
return ConfigUtil.class.getResource(fileName);
}
public static String getResourcePath(String fileName) {
URL url = getResource(fileName);
if (url == null) {
return null;
}
try {
return url.toURI().getPath();
} catch (URISyntaxException e) {
return null;
}
}
public static InputStream getResourceAsStream(String fileName) {
return ConfigUtil.class.getResourceAsStream(fileName);
}
//==================================================================================================================
}