com.sap.cds.feature.config.local

Class DefaultPropertiesProvider

java.lang.Object

com.sap.cds.feature.config.local.DefaultPropertiesProvider

All Implemented Interfaces:

PropertiesProvider, Feature

public class DefaultPropertiesProvider
extends Object
implements PropertiesProvider

Default implementation of PropertiesProvider based on parsing a yaml-config file.

Per default, the properties are loaded from ./application.yaml in the resource path. -DconfigFile=/somePath/config.yaml overrides the default location.

Per default, the active profile is either the first profile with name 'default' or the first profile in the yaml. -DconfigProfile=<profile-name> switches the active profile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPropertiesProvider.PropertiesRoot The YAML root representation

Constructor Summary

Constructors

Constructor and Description
DefaultPropertiesProvider()

Method Summary

Modifier and Type	Method and Description
<T> T	bindPropertyClass(String section, Class<T> clazz) Binds the configuration POJO to the specified section
String	getFeatureName()
<T> T	getProperty(String key, Class<T> clazz, T defaultValue) Returns the value of the property with given key as given type asClazz.
String	getProperty(String key, String defaultValue) Returns the value of the property with given key as String.
boolean	isActiveFeature() Checks if the feature is activated

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cds.feature.config.PropertiesProvider

getProperty, getProperty, hasProperty

Constructor Detail

DefaultPropertiesProvider

public DefaultPropertiesProvider()

Method Detail

bindPropertyClass

public <T> T bindPropertyClass(String section,
                               Class<T> clazz)

Description copied from interface: PropertiesProvider

Binds the configuration POJO to the specified section

Specified by:

bindPropertyClass in interface PropertiesProvider

Type Parameters:

T - the type of the POJO

Parameters:

section - the properties section

clazz - the class of the POJO

Returns:

The properties instance

getProperty

public String getProperty(String key,
                          String defaultValue)

Description copied from interface: PropertiesProvider

Returns the value of the property with given key as String. Returns the specified default value if key is not existing.

Specified by:

getProperty in interface PropertiesProvider

Parameters:

key - The key of the property

defaultValue - The default value if the key is not present

Returns:

The String value or defaultValue if not defined

getProperty

public <T> T getProperty(String key,
                         Class<T> clazz,
                         T defaultValue)

Description copied from interface: PropertiesProvider

Returns the value of the property with given key as given type asClazz. Returns the specified default value if key is not existing.

Specified by:

getProperty in interface PropertiesProvider

Type Parameters:

T - the type of the property value

Parameters:

key - The key of the property

clazz - The type of the property value

defaultValue - The default value if the key is not present

Returns:

The property value or defaultValue if not defined

isActiveFeature

public boolean isActiveFeature()

Description copied from interface: Feature

Checks if the feature is activated

Specified by:

isActiveFeature in interface Feature

Returns:

true if the feature is activated

getFeatureName

public String getFeatureName()

Specified by:

getFeatureName in interface Feature

Returns:

a name for the feature to be used in logging