com.neeve.config

Class Config

java.lang.Object

com.neeve.config.Config

public final class Config
extends Object

Centralized property based application configuration store

This class serves as the configuration store for property based configuration. The property set used by this class to resolve configuration property requests is prepared as follows:

1. Add environment as resolved by {#link com.neeve.env.Env}
2. Add all properties at the /env/default address in the default repository

This class MAY be used by end users, however its usage is not supported unless one is directed to do so by Neeve Support.

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
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 Properties	getProps() Returns the configuration store's property set.
static Properties	getPropsNoWarn() Returns the configuration store's property set.
static String	getRootDirectory() Get the runtime root directory.
static String	getUnmanagedJavaLibDirectory() Get the java unmanaged lib directory
static void	initialize(Properties props) Initializes the configuration store.
static void	reset() Resets the configuration store to its pre-initialized state.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

Method Detail

reset

public static final void reset()

Resets the configuration store to its pre-initialized state.

This method can be used to reset the configuration store to its original state. It is not intended for use in production environments and serves primarily as a mechanism for clearing out the configuration store 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 not safe for concurrent access by multiple threads with itself or any other method in this class.

initialize

public static final void initialize(Properties props)

Initializes the configuration store. This replaces any initially loaded bootstrap store with the provided property set.

Parameters:

props - The property set to initialize with.

Threading:

This method is safe for concurrent access by multiple threads.

getPropsNoWarn

public static final Properties getPropsNoWarn()

Returns the configuration store's property set.

Returns:

The property set.

Threading:

This method is safe for concurrent access by multiple threads.

getProps

public static final Properties getProps()

Returns the configuration store's property set.

The caller should not modify the returned set of properties. All mutative operations on the environment should be done via calls to this class instead.

Returns:

The store's property set

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 system 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)