Config (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.config.Config

public final class Config
extends Object

Singleton application configuration store

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Config.PerformanceTuning` Enumerates performance tuning
`static class`	`Config.State` Enumerates the various config states

Field Summary

Fields
Modifier and Type Field and Description

static String CONFIG_ENVENTITY_FULLNAME
Full name of the repositorie's simple entity containing environment properties

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_ENVENTITY_FULLNAME` Full name of the repositorie's simple entity containing environment properties

Constructor Summary

Constructors
Constructor and Description

Config()

Constructors
Constructor and Description
`Config()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`allowDuplicateEnvironmentInitialization(boolean val)` Sets whether duplicate initialization is permissible
`static boolean`	`checked()` Get whether system is globally configured to run in checked mode
`static boolean`	`compatibleWith3x()` Gets whether configuration settings should be compatible with X Platform 3.x
`static boolean`	`conserveCPU()` Gets whether or not an attempt will be made to conserve CPU (nv.conservecpu=true is set).
`static boolean`	`conserveMemory()` Gets whether or not an attempt will be made to conserve memory (nv.conservememory=true is set).
`static boolean`	`disableDisruptorWaitStrategyOptimizations()` Gets whether or not to disable disruptor wait strategy optimizations
`static String`	`getBinDirectory()` Get the runtime bin directory
`static String`	`getConfigDirectory()` Get the runtime configuration directory.
`static String`	`getDataDirectory()` Get the runtime data directory and create if absent.
`static String`	`getDataDirectory(boolean createIfAbsent)` Get the runtime data directory.
`static String`	`getJavaLibDirectory()` Get the java libs directory
`static String`	`getLogsDirectory()` Get the runtime trace log directory and create if absent.
`static String`	`getLogsDirectory(boolean createIfAbsent)` Get the runtime trace log directory.
`static String`	`getPlatform()` Get the runtime platform.
`static Properties`	`getPropertiesCopy()` Get a copy of the current environment property table
`static Properties`	`getPropertiesTo(Properties props)` Copy the current environment property table to a supplied property table
`static Set<String>`	`getPropertyNames()` Get the set of environment property names This method returns a copy of the set of property names currently in the configuration's environment
`static IConfigRepository`	`getRepository()` Get the configuration repository This method returns the underlying configuration repository.
`static String`	`getRootDirectory()` Get the runtime root directory.
`static Config.State`	`getState()` Get the config state
`static Tracer.Level`	`getTraceLevel(String prop)` Convenience method to get a tracer's level from the config environment
`static Tracer.Level`	`getTraceLevel(String prop, Tracer.Level defaultLevel)` Get a tracer's level from the config environment
`static String`	`getUnmanagedJavaLibDirectory()` Get the java unmanaged lib directory
`static String`	`getValue(String name)` Get a String property value from the config environment.
`static boolean`	`getValue(String name, boolean defValue)` Get a boolean property value from config environment.
`static byte`	`getValue(String name, byte defValue)` Get a byte property value from the config environment.
`static double`	`getValue(String name, double defValue)` Get a double property value from the config environment.
`static float`	`getValue(String name, float defValue)` Get a float property value from the config environment.
`static int`	`getValue(String name, int defValue)` Get an int property value from the config environment.
`static long`	`getValue(String name, long defValue)` Get an long property value from the config environment.
`static short`	`getValue(String name, short defValue)` Get a short property value from the config environment.
`static String`	`getValue(String name, String defValue)` Get a String property value from the config environment.
`static boolean`	`hasValue(String name)` Check if the config environment has a property
`static void`	`initializeEnvironment()` Initialize the configuration environment This method invokes `initializeEnviroment(null)`
`static Set<String>`	`initializeEnvironment(Properties props)` Initialize the configuration environment
`static boolean`	`isWindowsPlatform()` Get whether the an Rumi's runtime is installed on windows.
`static boolean`	`optimizeForLatency()` Deprecated. Use tuneForLatency() instead
`static boolean`	`optimizeForThroughput()` Deprecated. Use tuneForThroughput() instead
`static boolean`	`optimizeMemoryUsage()` Deprecated. Use conserveMemory() instead
`static void`	`reset(Properties systemProperties)` Reset configuration repository and environment
`static void`	`resetEnvironment()` Reset the configuration environment.
`static void`	`resetRepository()` Reset the configuration repository This method resets the underlying configuration repository.
`static void`	`setTraceLevel(Tracer tracer, String prop)` Convenience method to set a tracer's level from the config environment
`static void`	`setTraceLevel(Tracer tracer, String prop, Tracer.Level defaultLevel)` Convenience method to set a tracer's level from the config environment
`static boolean`	`tuneForLatency()` Get whether system is globally configured to tune for latency
`static boolean`	`tuneForThroughput()` Get whether system is globally configured to tune for throughput

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

- Field Detail
  - CONFIG_ENVENTITY_FULLNAME
```
public static final String CONFIG_ENVENTITY_FULLNAME
```
    Full name of the repositorie's simple entity containing environment properties
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Config
```
public Config()
```
- Method Detail
  - allowDuplicateEnvironmentInitialization
```
public static final void allowDuplicateEnvironmentInitialization(boolean val)
```
    Sets whether duplicate initialization is permissible
  - initializeEnvironment
```
public static final Set<String> initializeEnvironment(Properties props)
```
    Initialize the configuration environment
    
    Parameters:
    
    props - Set of properties that override all other sources for the environment
    
    Returns:
    
    Returns the set of properties that were accessed by the caller in the bootstrap phase (prior to invocation of this method) that changed on initialization.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - initializeEnvironment
```
public static final void initializeEnvironment()
```
    Initialize the configuration environment
    This method invokes initializeEnviroment(null)
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getState
```
public static final Config.State getState()
```
    Get the config state
  - getTraceLevel
```
public static final Tracer.Level getTraceLevel(String prop,
                                               Tracer.Level defaultLevel)
```
    Get a tracer's level from the config environment
  - getTraceLevel
```
public static final Tracer.Level getTraceLevel(String prop)
```
    Convenience method to get a tracer's level from the config environment
  - setTraceLevel
```
public static final void setTraceLevel(Tracer tracer,
                                       String prop,
                                       Tracer.Level defaultLevel)
```
    Convenience method to set a tracer's level from the config environment
  - setTraceLevel
```
public static final void setTraceLevel(Tracer tracer,
                                       String prop)
```
    Convenience method to set a tracer's level from the config environment
  - getPropertyNames
```
public static final Set<String> getPropertyNames()
```
    Get the set of environment property names
    This method returns a copy of the set of property names currently in the configuration's environment
    
    Returns:
    
    Returns the set of environment property names
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getPropertiesTo
```
public static final Properties getPropertiesTo(Properties props)
```
    Copy the current environment property table to a supplied property table
    
    Returns:
    
    Returns the supplied properties table
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getPropertiesCopy
```
public static final Properties getPropertiesCopy()
```
    Get a copy of the current environment property table
    
    Returns:
    
    Returns the copy of the properties table
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - hasValue
```
public static final boolean hasValue(String name)
```
    Check if the config environment has a property
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    Returns true if the property exist
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final byte getValue(String name,
                                  byte defValue)
```
    Get a byte property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a byte value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final short getValue(String name,
                                   short defValue)
```
    Get a short property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a short value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final int getValue(String name,
                                 int defValue)
```
    Get an int property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as an int value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final long getValue(String name,
                                  long defValue)
```
    Get an long property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as an long value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final float getValue(String name,
                                   float defValue)
```
    Get a float property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a float value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final double getValue(String name,
                                    double defValue)
```
    Get a double property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a double value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final boolean getValue(String name,
                                     boolean defValue)
```
    Get a boolean property value from config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a boolean value
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final String getValue(String name)
```
    Get a String property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    Returns the property value as a String
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getValue
```
public static final String getValue(String name,
                                    String defValue)
```
    Get a String property value from the config environment.
    
    Parameters:
    
    name - The property name
    
    defValue - The default property value to return in case the property is not present in the environment.
    
    Returns:
    
    Returns the property value as a String
    
    Throws:
    
    IllegalArgumentException - Thrown if supplied name is null
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getPlatform
```
public static final String getPlatform()
```
    Get the runtime platform.
    This method returns the runtime platform. The runtime platform is stored in the NVPLATFORM system property. A null value is returned in case the platform is not set.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - isWindowsPlatform
```
public static final boolean isWindowsPlatform()
```
    Get whether the an Rumi's runtime is installed on windows.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getRootDirectory
```
public static final String getRootDirectory()
```
    Get the runtime root directory.
    This method returns the runtime root directory. The runtime root directory is stored in the NVROOT environment property. In case the property is not set, the current directory ('.') is returned as the runtime root.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getBinDirectory
```
public static final String getBinDirectory()
```
    Get the runtime bin directory
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getConfigDirectory
```
public static final String getConfigDirectory()
```
    Get the runtime configuration directory.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getJavaLibDirectory
```
public static final String getJavaLibDirectory()
```
    Get the java libs directory
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getUnmanagedJavaLibDirectory
```
public static final String getUnmanagedJavaLibDirectory()
```
    Get the java unmanaged lib directory
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getDataDirectory
```
public static final String getDataDirectory(boolean createIfAbsent)
```
    Get the runtime data directory.
    
    Parameters:
    
    createIfAbsent - Causes the directory to be created if absent,
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getDataDirectory
```
public static final String getDataDirectory()
```
    Get the runtime data directory and create if absent.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
    This method is equivalent to the invoking getDataDirectory(true)
  - getLogsDirectory
```
public static final String getLogsDirectory(boolean createIfAbsent)
```
    Get the runtime trace log directory.
    
    Parameters:
    
    createIfAbsent - Causes the directory to be created if absent.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - getLogsDirectory
```
public static final String getLogsDirectory()
```
    Get the runtime trace log directory and create if absent.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
    This method is equivalent to the invoking getLogsDirectory(true)
  - checked
```
public static final boolean checked()
```
    Get whether system is globally configured to run in checked mode
  - tuneForLatency
```
public static final boolean tuneForLatency()
```
    Get whether system is globally configured to tune for latency
  - optimizeForLatency
```
public static final boolean optimizeForLatency()
```
    Deprecated. Use tuneForLatency() instead
  - tuneForThroughput
```
public static final boolean tuneForThroughput()
```
    Get whether system is globally configured to tune for throughput
  - optimizeForThroughput
```
public static final boolean optimizeForThroughput()
```
    Deprecated. Use tuneForThroughput() instead
  - optimizeMemoryUsage
```
@Deprecated
public static final boolean optimizeMemoryUsage()
```
    Deprecated. Use conserveMemory() instead
  - conserveMemory
```
public static final boolean conserveMemory()
```
    Gets whether or not an attempt will be made to conserve memory (nv.conservememory=true is set).
    When set this instructs the runtime to try to conserve memory
    
    Returns:
    
    Whether or not to conserve memory.
  - conserveCPU
```
public static final boolean conserveCPU()
```
    Gets whether or not an attempt will be made to conserve CPU (nv.conservecpu=true is set).
    When set this instructs the runtime to try to conserve CPU resources by avoiding spinning.
    
    Returns:
    
    Whether or not to conserve CPU.
  - disableDisruptorWaitStrategyOptimizations
```
public static final boolean disableDisruptorWaitStrategyOptimizations()
```
    Gets whether or not to disable disruptor wait strategy optimizations
    
    Returns:
    
    Whether or not to disable wait strategy optimizations.
  - compatibleWith3x
```
public static final boolean compatibleWith3x()
```
    Gets whether configuration settings should be compatible with X Platform 3.x
    
    Returns:
    
    Whether or not configuration settings are compatible with X 3.x
  - getRepository
```
public static final IConfigRepository getRepository()
```
    Get the configuration repository
    This method returns the underlying configuration repository. Subsequent invocations of this method will return the same instance of the repository until resetRepository() is called after which the first invocation of this method will reinitialize the underlying repository.
  - resetEnvironment
```
public static final void resetEnvironment()
```
    Reset the configuration environment.
    This method resets the configuration environment to its pre-initialized state.
    This method IS NOT intended for use in production environments. It serves primarily as a mechanism for clearing out the configuration environment in unit testing scenarios. This method IS NOT recommend to be used by end users and may be removed or altered without notice
    
    Threading:
    
    This method is safe for concurrent access by multiple threads.
  - resetRepository
```
public static final void resetRepository()
```
    Reset the configuration repository
    This method resets the underlying configuration repository. This will cause a subsequent invocation of getRepository() to reinitialize the underlying repository.
  - reset
```
public static final void reset(Properties systemProperties)
```
    Reset configuration repository and environment
    
    Parameters:
    
    systemProperties - If not null, the method will replace the system properties with these supplied properties.
    This method resets the configuration environment and repository and, optionally, resets the system properties to a supplied set of properties.

Class Config

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_ENVENTITY_FULLNAME

Constructor Detail

Config

Method Detail

allowDuplicateEnvironmentInitialization

initializeEnvironment

initializeEnvironment

getState

getTraceLevel

getTraceLevel

setTraceLevel

setTraceLevel

getPropertyNames

getPropertiesTo

getPropertiesCopy

hasValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

getPlatform

isWindowsPlatform

getRootDirectory

getBinDirectory

getConfigDirectory

getJavaLibDirectory

getUnmanagedJavaLibDirectory

getDataDirectory

getDataDirectory

getLogsDirectory

getLogsDirectory

checked

tuneForLatency

optimizeForLatency

tuneForThroughput

optimizeForThroughput

optimizeMemoryUsage

conserveMemory

conserveCPU

disableDisruptorWaitStrategyOptimizations

compatibleWith3x

getRepository

resetEnvironment

resetRepository

reset