com.yahoo.bard.webservice.config

Interface SystemConfig

All Known Implementing Classes:

LayeredFileSystemConfig

public interface SystemConfig

System Config provides an interface for retrieving configuration values, allowing for implicit type conversion, defaulting, and use of a runtime properties interface to override configured settings.

Method Summary

Modifier and Type	Method and Description
default void	clearProperty(String key) Remove property from the user-defined runtime configuration.
default boolean	getBooleanProperty(String key) Get property value for a key.
default boolean	getBooleanProperty(String key, boolean defaultValue) Get property value for a key.
default double	getDoubleProperty(String key) Get property value for a key.
default double	getDoubleProperty(String key, double defaultValue) Get property value for a key.
default float	getFloatProperty(String key) Get property value for a key.
default float	getFloatProperty(String key, float defaultValue) Get property value for a key.
default int	getIntProperty(String key) Get property value for a key.
default int	getIntProperty(String key, int defaultValue) Get property value for a key.
default <T> List<T>	getListProperty(String key) Get property value for a key.
default <T> List<T>	getListProperty(String key, List<T> defaultValue) Get property value for a key.
default long	getLongProperty(String key) Get property value for a key.
default long	getLongProperty(String key, long defaultValue) Get property value for a key.
org.apache.commons.configuration.Configuration	getMasterConfiguration() Get the internal System Configuration instance.
default String	getPackageVariableName(String suffix) Get a package scoped variable name.
Properties	getRuntimeProperties() The properties file used to hold modified SystemConfiguration values.
default String	getStringProperty(String key) Get property value for a key.
default String	getStringProperty(String key, String defaultValue) Get property value for a key.
default void	resetProperty(String key, String value) Remove property from the user-defined runtime configuration.
default void	setProperty(String key, String value) Set property value for a key.

Method Detail

getPackageVariableName

default String getPackageVariableName(String suffix)

Get a package scoped variable name.

Parameters:

suffix - The variable name of the configuration variable without the package prefix

Returns:

variable name

getStringProperty

default String getStringProperty(@NotNull
                                 String key)
                          throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

requestedPropertyValue The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getIntProperty

default int getIntProperty(@NotNull
                           String key)
                    throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

requestedPropertyValue The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getBooleanProperty

default boolean getBooleanProperty(@NotNull
                                   String key)
                            throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

requestedPropertyValue The value for the requested key, false if null

Throws:

SystemConfigException - A system exception if any errors occurred

getFloatProperty

default float getFloatProperty(@NotNull
                               String key)
                        throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getDoubleProperty

default double getDoubleProperty(@NotNull
                                 String key)
                          throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getLongProperty

default long getLongProperty(@NotNull
                             String key)
                      throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getListProperty

default <T> List<T> getListProperty(@NotNull
                                    String key)
                             throws SystemConfigException

Get property value for a key.

Type Parameters:

T - The expected type of item in the list

Parameters:

key - The key for which value needs to be fetched, not null

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getStringProperty

default String getStringProperty(@NotNull
                                 String key,
                                 String defaultValue)
                          throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

requestedPropertyValue The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getIntProperty

default int getIntProperty(@NotNull
                           String key,
                           int defaultValue)
                    throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

requestedPropertyValue The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getBooleanProperty

default boolean getBooleanProperty(@NotNull
                                   String key,
                                   boolean defaultValue)
                            throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

requestedPropertyValue The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getFloatProperty

default float getFloatProperty(@NotNull
                               String key,
                               float defaultValue)
                        throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getDoubleProperty

default double getDoubleProperty(@NotNull
                                 String key,
                                 double defaultValue)
                          throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getLongProperty

default long getLongProperty(@NotNull
                             String key,
                             long defaultValue)
                      throws SystemConfigException

Get property value for a key.

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

getListProperty

default <T> List<T> getListProperty(@NotNull
                                    String key,
                                    List<T> defaultValue)
                             throws SystemConfigException

Get property value for a key.

Type Parameters:

T - The expected type of item in the list

Parameters:

key - The key for which value needs to be fetched, not null

defaultValue - The value to return if there is no configured value

Returns:

The value for the requested key

Throws:

SystemConfigException - A system exception if any errors occurred

setProperty

default void setProperty(@NotNull
                         String key,
                         String value)
                  throws SystemConfigException

Set property value for a key.

Parameters:

key - The key of the property to change, not null

value - The new value

Throws:

SystemConfigException - A system exception if any errors occurred

clearProperty

default void clearProperty(@NotNull
                           String key)

Remove property from the user-defined runtime configuration.

Parameters:

key - The key of the property to remove.

resetProperty

default void resetProperty(@NotNull
                           String key,
                           String value)

Remove property from the user-defined runtime configuration. If value is null, clear the property, otherwise set property to value.

Parameters:

key - The key of the property to remove.

value - The value to reset to (if not null)

getMasterConfiguration

org.apache.commons.configuration.Configuration getMasterConfiguration()

Get the internal System Configuration instance. This method is intended primary for interface support and not for client interactions.

Returns:

The composite configuration which backs this System Configuration

getRuntimeProperties

Properties getRuntimeProperties()

The properties file used to hold modified SystemConfiguration values. This method is intended primary for interface support and not for client interactions.

Returns:

A properties object which acts as a runtime mask against other configuration properties