Class ConfigurationUtils

java.lang.Object

org.opensearch.core.util.ConfigurationUtils

@PublicApi(since="3.0.0")
public final class ConfigurationUtils
extends Object

Utility class for parsing configurations.

Opensearch.api:

Method Summary

Modifier and Type	Method	Description
static OpenSearchException	newConfigurationException(String propertyName, String reason)
static boolean	readBooleanProperty(Map<String,Object> configuration, String propertyName, boolean defaultValue)
static Double	readDoubleProperty(Map<String,Object> configuration, String propertyName)	Returns the specified property from the specified configuration map.
static Integer	readIntProperty(Map<String,Object> configuration, String propertyName, Integer defaultValue)	Returns the specified property from the specified configuration map.
static String	readOptionalStringOrIntProperty(Map<String,Object> configuration, String propertyName)	Returns the specified property from the specified configuration map.
static String	readOptionalStringProperty(Map<String,Object> configuration, String propertyName)	Returns and removes the specified optional property from the specified configuration map.
static String	readStringOrIntProperty(Map<String,Object> configuration, String propertyName, String defaultValue)	Returns the specified property from the specified configuration map.
static String	readStringProperty(Map<String,Object> configuration, String propertyName)	Returns and removes the specified property from the specified configuration map.
static String	readStringProperty(Map<String,Object> configuration, String propertyName, String defaultValue)	Returns the specified property from the specified configuration map.

Methods inherited from class java.lang.Object

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

Method Details

readOptionalStringProperty

public static String readOptionalStringProperty(Map<String,Object> configuration,
 String propertyName)

Returns and removes the specified optional property from the specified configuration map.

If the property value isn't of type string a OpenSearchParseException is thrown.

readStringProperty

public static String readStringProperty(Map<String,Object> configuration,
 String propertyName)

Returns and removes the specified property from the specified configuration map.

If the property value isn't of type string an OpenSearchParseException is thrown. If the property is missing an OpenSearchParseException is thrown

readStringProperty

public static String readStringProperty(Map<String,Object> configuration,
 String propertyName,
 String defaultValue)

Returns the specified property from the specified configuration map.

If the property value isn't of type string a OpenSearchParseException is thrown. If the property is missing and no default value has been specified a OpenSearchParseException is thrown

newConfigurationException

public static OpenSearchException newConfigurationException(String propertyName,
 String reason)

readStringOrIntProperty

public static String readStringOrIntProperty(Map<String,Object> configuration,
 String propertyName,
 String defaultValue)

Returns the specified property from the specified configuration map.

If the property value isn't of type string or int a OpenSearchParseException is thrown. If the property is missing and no default value has been specified a OpenSearchParseException is thrown

readOptionalStringOrIntProperty

public static String readOptionalStringOrIntProperty(Map<String,Object> configuration,
 String propertyName)

Returns the specified property from the specified configuration map.

If the property value isn't of type string or int a OpenSearchParseException is thrown.

readBooleanProperty

public static boolean readBooleanProperty(Map<String,Object> configuration,
 String propertyName,
 boolean defaultValue)

readIntProperty

public static Integer readIntProperty(Map<String,Object> configuration,
 String propertyName,
 Integer defaultValue)

Returns the specified property from the specified configuration map.

If the property value isn't of type int a OpenSearchParseException is thrown. If the property is missing an OpenSearchParseException is thrown

readDoubleProperty

public static Double readDoubleProperty(Map<String,Object> configuration,
 String propertyName)

Returns the specified property from the specified configuration map.

If the property value isn't of type int a OpenSearchParseException is thrown. If the property is missing an OpenSearchParseException is thrown