Configuration (Alluxio Parent 1.8.3-SNAPSHOT API)

java.lang.Object
- alluxio.Configuration

```
@NotThreadSafe
public final class Configuration
extends Object
```
Global configuration properties of Alluxio. This class works like a dictionary and serves each Alluxio configuration property as a key-value pair.
Alluxio configuration properties are loaded into this class in the following order with decreasing priority:
1. Java system properties;
2. Environment variables via alluxio-env.sh or from OS settings;
3. Site specific properties via alluxio-site.properties file;
The default properties are defined in the PropertyKey class in the codebase. Alluxio users can override values of these default properties by creating alluxio-site.properties and putting it under java CLASSPATH when running Alluxio (e.g., ${ALLUXIO_HOME}/conf/)
This class defines many convenient static methods which delegate to an internal InstancedConfiguration. To use this global configuration in a method that takes AlluxioConfiguration as an argument, pass global().

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`containsKey(PropertyKey key)` Deprecated. due to misleading method name, use {`isSet(PropertyKey)`} instead
`static String`	`get(PropertyKey key)` Gets the value for the given key in the `Properties`; if this key is not found, a RuntimeException is thrown.
`static String`	`get(PropertyKey key, ConfigurationValueOptions options)` Gets the value for the given key in the `Properties`; if this key is not found, a RuntimeException is thrown.
`static boolean`	`getBoolean(PropertyKey key)` Gets the boolean representation of the value for the given key.
`static long`	`getBytes(PropertyKey key)` Gets the bytes of the value for the given key.
`static <T> Class<T>`	`getClass(PropertyKey key)` Gets the value for the given key as a class.
`static double`	`getDouble(PropertyKey key)` Gets the double representation of the value for the given key.
`static java.time.Duration`	`getDuration(PropertyKey key)` Gets the time of the key as a duration.
`static <T extends Enum<T>> T`	`getEnum(PropertyKey key, Class<T> enumType)` Gets the value for the given key as an enum value.
`static float`	`getFloat(PropertyKey key)` Gets the float representation of the value for the given key.
`static int`	`getInt(PropertyKey key)` Gets the integer representation of the value for the given key.
`static List<String>`	`getList(PropertyKey key, String delimiter)` Gets the value for the given key as a list.
`static long`	`getLong(PropertyKey key)` Gets the long representation of the value for the given key.
`static long`	`getMs(PropertyKey key)` Gets the time of key in millisecond unit.
`static Map<String,String>`	`getNestedProperties(PropertyKey prefixKey)` Gets a set of properties that share a given common prefix key as a map.
`static String`	`getOrDefault(PropertyKey key, String defaultValue)`
`static String`	`getOrDefault(PropertyKey key, String defaultValue, ConfigurationValueOptions options)`
`static Source`	`getSource(PropertyKey key)`
`static InstancedConfiguration`	`global()`
`static boolean`	`isSet(PropertyKey key)` Checks if the configuration contains a value for the given key.
`static Set<PropertyKey>`	`keySet()`
`static void`	`merge(Map<?,?> properties, Source source)` Merges the current configuration properties with new properties.
`static void`	`reset()` Resets `Configuration` back to the default one.
`static void`	`set(PropertyKey key, Object value)` Sets the value for the appropriate key in the `Properties`.
`static void`	`set(PropertyKey key, Object value, Source source)` Sets the value for the appropriate key in the `Properties` by source.
`static Map<String,String>`	`toMap()`
`static Map<String,String>`	`toMap(ConfigurationValueOptions opts)`
`static void`	`unset(PropertyKey key)` Unsets the value for the appropriate key in the `Properties`.
`static void`	`validate()` Validates the configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - reset
```
public static void reset()
```
    Resets Configuration back to the default one.
  - merge
```
public static void merge(Map<?,?> properties,
                         Source source)
```
    Merges the current configuration properties with new properties. If a property exists both in the new and current configuration, the one from the new configuration wins if its priority is higher or equal than the existing one.
    
    Parameters:
    
    properties - the source Properties to be merged
    
    source - the source of the the properties (e.g., system property, default and etc)
  - set
```
public static void set(PropertyKey key,
                       Object value)
```
    Sets the value for the appropriate key in the Properties.
    
    Parameters:
    
    key - the key to set
    
    value - the value for the key
  - set
```
public static void set(PropertyKey key,
                       Object value,
                       Source source)
```
    Sets the value for the appropriate key in the Properties by source.
    
    Parameters:
    
    key - the key to set
    
    value - the value for the key
    
    source - the source of the the properties (e.g., system property, default and etc)
  - unset
```
public static void unset(PropertyKey key)
```
    Unsets the value for the appropriate key in the Properties.
    
    Parameters:
    
    key - the key to unset
  - get
```
public static String get(PropertyKey key)
```
    Gets the value for the given key in the Properties; if this key is not found, a RuntimeException is thrown.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key
  - get
```
public static String get(PropertyKey key,
                         ConfigurationValueOptions options)
```
    Gets the value for the given key in the Properties; if this key is not found, a RuntimeException is thrown.
    
    Parameters:
    
    key - the key to get the value for
    
    options - options for getting configuration value
    
    Returns:
    
    the value for the given key
  - getOrDefault
```
public static String getOrDefault(PropertyKey key,
                                  String defaultValue)
```
    Parameters:
    
    key - the key to get the value for
    
    defaultValue - the value to return if no value is set for the specified key
    
    Returns:
    
    the value
  - getOrDefault
```
public static String getOrDefault(PropertyKey key,
                                  String defaultValue,
                                  ConfigurationValueOptions options)
```
    Parameters:
    
    key - the key to get the value for
    
    defaultValue - the value to return if no value is set for the specified key
    
    options - options for getting configuration value
    
    Returns:
    
    the value
  - containsKey
```
@Deprecated
public static boolean containsKey(PropertyKey key)
```
    Deprecated. due to misleading method name, use {isSet(PropertyKey)} instead
    
    Checks if the configuration contains a value for the given key.
    
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true if there is value for the key, false otherwise
  - isSet
```
public static boolean isSet(PropertyKey key)
```
    Checks if the configuration contains a value for the given key.
    
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true if there is value for the key, false otherwise
  - keySet
```
public static Set<PropertyKey> keySet()
```
    Returns:
    
    the keys configured by the configuration
  - getInt
```
public static int getInt(PropertyKey key)
```
    Gets the integer representation of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as an int
  - getLong
```
public static long getLong(PropertyKey key)
```
    Gets the long representation of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a long
  - getDouble
```
public static double getDouble(PropertyKey key)
```
    Gets the double representation of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a double
  - getFloat
```
public static float getFloat(PropertyKey key)
```
    Gets the float representation of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a float
  - getBoolean
```
public static boolean getBoolean(PropertyKey key)
```
    Gets the boolean representation of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a boolean
  - getList
```
public static List<String> getList(PropertyKey key,
                                   String delimiter)
```
    Gets the value for the given key as a list.
    
    Parameters:
    
    key - the key to get the value for
    
    delimiter - the delimiter to split the values
    
    Returns:
    
    the list of values for the given key
  - getEnum
```
public static <T extends Enum<T>> T getEnum(PropertyKey key,
                                            Class<T> enumType)
```
    Gets the value for the given key as an enum value.
    
    Type Parameters:
    
    T - the type of the enum
    
    Parameters:
    
    key - the key to get the value for
    
    enumType - the type of the enum
    
    Returns:
    
    the value for the given key as an enum value
  - getBytes
```
public static long getBytes(PropertyKey key)
```
    Gets the bytes of the value for the given key.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the bytes of the value for the given key
  - getMs
```
public static long getMs(PropertyKey key)
```
    Gets the time of key in millisecond unit.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the time of key in millisecond unit
  - getDuration
```
public static java.time.Duration getDuration(PropertyKey key)
```
    Gets the time of the key as a duration.
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value of the key represented as a duration
  - getClass
```
public static <T> Class<T> getClass(PropertyKey key)
```
    Gets the value for the given key as a class.
    
    Type Parameters:
    
    T - the type of the class
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a class
  - getNestedProperties
```
public static Map<String,String> getNestedProperties(PropertyKey prefixKey)
```
    Gets a set of properties that share a given common prefix key as a map. E.g., if A.B=V1 and A.C=V2, calling this method with prefixKey=A returns a map of {B=V1, C=V2}, where B and C are also valid properties. If no property shares the prefix, an empty map is returned.
    
    Parameters:
    
    prefixKey - the prefix key
    
    Returns:
    
    a map from nested properties aggregated by the prefix
  - getSource
```
public static Source getSource(PropertyKey key)
```
    Parameters:
    
    key - the property key
    
    Returns:
    
    the source for the given key
  - toMap
```
public static Map<String,String> toMap()
```
    Returns:
    
    a map from all configuration property names to their values; values may potentially be null
  - toMap
```
public static Map<String,String> toMap(ConfigurationValueOptions opts)
```
    Parameters:
    
    opts - options for formatting the configuration values
    
    Returns:
    
    a map from all configuration property names to their values; values may potentially be null
  - validate
```
public static void validate()
```
    Validates the configuration.
    
    Throws:
    
    IllegalStateException - if invalid configuration is encountered
  - global
```
public static InstancedConfiguration global()
```
    Returns:
    
    the InstancedConfiguration object backing the global configuration

Class Configuration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reset

merge

set

set

unset

get

get

getOrDefault

getOrDefault

containsKey

isSet

keySet

getInt

getLong

getDouble

getFloat

getBoolean

getList

getEnum

getBytes

getMs

getDuration

getClass

getNestedProperties

getSource

toMap

toMap

validate

global