org.apache.gobblin.util

Class ConfigUtils

java.lang.Object

org.apache.gobblin.util.ConfigUtils

public class ConfigUtils
extends Object

Utility class for dealing with Config objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRIP_SUFFIX A suffix that is automatically appended to property keys that are prefixes of other property keys.

Constructor Summary

Constructors

Constructor and Description
ConfigUtils(FileUtils fileUtils)

Method Summary

Modifier and Type	Method and Description
static Properties	configToProperties(com.typesafe.config.Config config) Convert a given Config instance to a Properties instance.
static Properties	configToProperties(com.typesafe.config.Config config, com.google.common.base.Optional<String> prefix) Convert a given Config instance to a Properties instance.
static Properties	configToProperties(com.typesafe.config.Config config, String prefix) Convert a given Config instance to a Properties instance.
static State	configToState(com.typesafe.config.Config config) Convert a given Config to a State instance.
static String	desanitizeKey(String propKey)
static String	emptyIfNotPresent(com.typesafe.config.Config config, String path) Return string value at path if config has path.
static Set<String>	findFullPrefixKeys(Properties properties, com.google.common.base.Optional<String> keyPrefix) Finds a list of properties whose keys are complete prefix of other keys.
static boolean	getBoolean(com.typesafe.config.Config config, String path, boolean def) Return boolean value at path if config has path.
static com.typesafe.config.Config	getConfig(com.typesafe.config.Config config, String path, com.typesafe.config.Config def) Return Config value at path if config has path.
static com.typesafe.config.Config	getConfigOrEmpty(com.typesafe.config.Config config, String key)
static double	getDouble(com.typesafe.config.Config config, String path, double def) Return double value at path if config has path.
static Integer	getInt(com.typesafe.config.Config config, String path, Integer def) Return Integer value at path if config has path.
static Long	getLong(com.typesafe.config.Config config, String path, Long def) Return Long value at path if config has path.
static String	getString(com.typesafe.config.Config config, String path, String def) Return string value at path if config has path.
static List<String>	getStringList(com.typesafe.config.Config config, String path) An extension to Config.getStringList(String).
static TimeUnit	getTimeUnit(com.typesafe.config.Config config, String path, TimeUnit def) Return TimeUnit value at path if config has path.
static boolean	hasNonEmptyPath(com.typesafe.config.Config config, String key) Check if the given key exists in config and it is not null or empty Uses StringUtils.isNotBlank(CharSequence)
static com.typesafe.config.Config	propertiesToConfig(Properties properties) Convert a given Properties to a Config instance.
static com.typesafe.config.Config	propertiesToConfig(Properties properties, com.google.common.base.Optional<String> prefix) Convert all the keys that start with a prefix in Properties to a Config instance.
static com.typesafe.config.Config	propertiesToTypedConfig(Properties properties, com.google.common.base.Optional<String> prefix) Convert all the keys that start with a prefix in Properties to a Config instance.
static com.typesafe.config.Config	resolveEncrypted(com.typesafe.config.Config config, com.google.common.base.Optional<String> encConfigPath) Resolves encrypted config value(s) by considering on the path with "encConfigPath" as encrypted.
static boolean	sanitizedKey(String propKey) returns true if is it a sanitized key
static String	sanitizeFullPrefixKey(String propKey)
void	saveConfigToFile(com.typesafe.config.Config config, Path destPath)
static boolean	verifySubset(com.typesafe.config.Config superConfig, com.typesafe.config.Config subConfig) Check that every key-value in superConfig is in subConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STRIP_SUFFIX

public static final String STRIP_SUFFIX

A suffix that is automatically appended to property keys that are prefixes of other property keys. This is used during Properties -> Config -> Properties conversion since typesafe config does not allow such properties.

See Also:

Constant Field Values

Constructor Detail

ConfigUtils

public ConfigUtils(FileUtils fileUtils)

Method Detail

saveConfigToFile

public void saveConfigToFile(com.typesafe.config.Config config,
                             Path destPath)
                      throws IOException

Throws:

IOException

configToProperties

public static Properties configToProperties(com.typesafe.config.Config config)

Convert a given Config instance to a Properties instance.

Parameters:

config - the given Config instance

Returns:

a Properties instance

configToProperties

public static Properties configToProperties(com.typesafe.config.Config config,
                                            com.google.common.base.Optional<String> prefix)

Convert a given Config instance to a Properties instance. If the config value is not of String type, it will try to get it as a generic Object type using com.typesafe.config.Config#getAnyRef() and then try to return its json representation as a string

Parameters:

config - the given Config instance

prefix - an optional prefix; if present, only properties whose name starts with the prefix will be returned.

Returns:

a Properties instance

configToProperties

public static Properties configToProperties(com.typesafe.config.Config config,
                                            String prefix)

Convert a given Config instance to a Properties instance.

Parameters:

config - the given Config instance

prefix - only properties whose name starts with the prefix will be returned.

Returns:

a Properties instance

getConfigOrEmpty

public static com.typesafe.config.Config getConfigOrEmpty(com.typesafe.config.Config config,
                                                          String key)

Returns:

the subconfig under key "key" if it exists, otherwise returns an empty config.

configToState

public static State configToState(com.typesafe.config.Config config)

Convert a given Config to a State instance.

Parameters:

config - the given Config instance

Returns:

a State instance

propertiesToConfig

public static com.typesafe.config.Config propertiesToConfig(Properties properties)

Convert a given Properties to a Config instance.

This method will throw an exception if (1) the Object.toString() method of any two keys in the Properties objects returns the same String, or (2) if any two keys are prefixes of one another, see the Java Docs of ConfigFactory.parseMap(Map) for more details.

Parameters:

properties - the given Properties instance

Returns:

a Config instance

findFullPrefixKeys

public static Set<String> findFullPrefixKeys(Properties properties,
                                             com.google.common.base.Optional<String> keyPrefix)

Finds a list of properties whose keys are complete prefix of other keys. This function is meant to be used during conversion from Properties to typesafe Config as the latter does not support this scenario.

Parameters:

properties - the Properties collection to inspect

keyPrefix - an optional key prefix which limits which properties are inspected.

propertiesToConfig

public static com.typesafe.config.Config propertiesToConfig(Properties properties,
                                                            com.google.common.base.Optional<String> prefix)

Convert all the keys that start with a prefix in Properties to a Config instance.

This method will throw an exception if (1) the Object.toString() method of any two keys in the Properties objects returns the same String, or (2) if any two keys are prefixes of one another, see the Java Docs of ConfigFactory.parseMap(Map) for more details.

Parameters:

properties - the given Properties instance

prefix - of keys to be converted

Returns:

a Config instance

sanitizeFullPrefixKey

public static String sanitizeFullPrefixKey(String propKey)

sanitizedKey

public static boolean sanitizedKey(String propKey)

returns true if is it a sanitized key

desanitizeKey

public static String desanitizeKey(String propKey)

propertiesToTypedConfig

public static com.typesafe.config.Config propertiesToTypedConfig(Properties properties,
                                                                 com.google.common.base.Optional<String> prefix)

Convert all the keys that start with a prefix in Properties to a Config instance. The method also tries to guess the types of properties.

This method will throw an exception if (1) the Object.toString() method of any two keys in the Properties objects returns the same String, or (2) if any two keys are prefixes of one another, see the Java Docs of ConfigFactory.parseMap(Map) for more details.

Parameters:

properties - the given Properties instance

prefix - of keys to be converted

Returns:

a Config instance

emptyIfNotPresent

public static String emptyIfNotPresent(com.typesafe.config.Config config,
                                       String path)

Return string value at path if config has path. If not return an empty string

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

string value at path if config has path. If not return an empty string

getString

public static String getString(com.typesafe.config.Config config,
                               String path,
                               String def)

Return string value at path if config has path. If not return def If the config value is not of String type, it will try to get it as a generic Object type using com.typesafe.config.Config#getAnyRef() and then try to return its json representation as a string

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

string value at path if config has path. If not return def

getTimeUnit

public static TimeUnit getTimeUnit(com.typesafe.config.Config config,
                                   String path,
                                   TimeUnit def)

Return TimeUnit value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

TimeUnit value at path if config has path. If not return def

getLong

public static Long getLong(com.typesafe.config.Config config,
                           String path,
                           Long def)

Return Long value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

Long value at path if config has path. If not return def

getInt

public static Integer getInt(com.typesafe.config.Config config,
                             String path,
                             Integer def)

Return Integer value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

Integer value at path if config has path. If not return def

getBoolean

public static boolean getBoolean(com.typesafe.config.Config config,
                                 String path,
                                 boolean def)

Return boolean value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

boolean value at path if config has path. If not return def

getDouble

public static double getDouble(com.typesafe.config.Config config,
                               String path,
                               double def)

Return double value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

double value at path if config has path. If not return def

getConfig

public static com.typesafe.config.Config getConfig(com.typesafe.config.Config config,
                                                   String path,
                                                   com.typesafe.config.Config def)

Return Config value at path if config has path. If not return def

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

config value at path if config has path. If not return def

getStringList

public static List<String> getStringList(com.typesafe.config.Config config,
                                         String path)

An extension to Config.getStringList(String). The value at path can either be a TypeSafe ConfigList of strings in which case it delegates to Config.getStringList(String) or as list of comma separated strings in which case it splits the comma separated list.

Additionally

Returns an empty list if path does not exist removes any leading and lagging quotes from each string in the returned list. Examples below will all return a list [1,2,3] without quotes

• a.b=[1,2,3]
• a.b=["1","2","3"]
• a.b=1,2,3
• a.b="1","2","3"

Parameters:

config - in which the path may be present

path - key to look for in the config object

Returns:

list of strings

hasNonEmptyPath

public static boolean hasNonEmptyPath(com.typesafe.config.Config config,
                                      String key)

Check if the given key exists in config and it is not null or empty Uses StringUtils.isNotBlank(CharSequence)

Parameters:

config - which may have the key

key - to look for in the config

Returns:

True if key exits and not null or empty. False otherwise

verifySubset

public static boolean verifySubset(com.typesafe.config.Config superConfig,
                                   com.typesafe.config.Config subConfig)

Check that every key-value in superConfig is in subConfig

resolveEncrypted

public static com.typesafe.config.Config resolveEncrypted(com.typesafe.config.Config config,
                                                          com.google.common.base.Optional<String> encConfigPath)

Resolves encrypted config value(s) by considering on the path with "encConfigPath" as encrypted. (If encConfigPath is absent or encConfigPath does not exist in config, config will be just returned untouched.) It will use Password manager via given config. Thus, convention of PasswordManager need to be followed in order to be decrypted. Note that "encConfigPath" path will be removed from the config key, leaving child path on the config key. e.g: encConfigPath = enc.conf - Before : { enc.conf.secret_key : ENC(rOF43721f0pZqAXg#63a) } - After : { secret_key : decrypted_val }

Parameters:

config -

encConfigPath -

Returns: