com.cloudera.director.aws.common

Class ConfigFragmentWrapper

java.lang.Object

com.cloudera.director.aws.common.ConfigFragmentWrapper

All Implemented Interfaces:

com.cloudera.director.spi.v1.model.Configured

public class ConfigFragmentWrapper
extends Object
implements com.cloudera.director.spi.v1.model.Configured

Wraps a HOCON config fragment object as an SPI configured object.

See Also:

Config, Configured

Constructor Summary

Constructors

Constructor and Description
ConfigFragmentWrapper(com.typesafe.config.Config config, List<com.cloudera.director.spi.v1.model.ConfigurationProperty>... components) Constructs a new wrapper around a config instance.

Method Summary

Modifier and Type	Method and Description
void	dump(String description, Logger logger, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Dumps all the properties as multiple log lines for debugging.
Map<String,String>	getConfiguration(com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Builds a map with all the configuration properties.
String	getConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationProperty property, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Gets the value of a configuration property from the underlying config object.
String	getConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken token, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Gets the value of a configuration property from the underlying config object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigFragmentWrapper

public ConfigFragmentWrapper(com.typesafe.config.Config config,
                             List<com.cloudera.director.spi.v1.model.ConfigurationProperty>... components)

Constructs a new wrapper around a config instance.

Parameters:

config - fragment of a config object

components - properties that should be exposed from the underlying object

Method Detail

getConfiguration

public Map<String,String> getConfiguration(com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Builds a map with all the configuration properties. Mandatory missing properties are just ignored and the result is immutable.

Specified by:

getConfiguration in interface com.cloudera.director.spi.v1.model.Configured

Parameters:

localizationContext - the localization context

getConfigurationValue

public String getConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken token,
                                    com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Gets the value of a configuration property from the underlying config object.

Specified by:

getConfigurationValue in interface com.cloudera.director.spi.v1.model.Configured

Parameters:

token - a description for a configuration property

localizationContext - the localization context

Throws:

NoSuchElementException - on missing required properties

getConfigurationValue

public String getConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationProperty property,
                                    com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Gets the value of a configuration property from the underlying config object.

Specified by:

getConfigurationValue in interface com.cloudera.director.spi.v1.model.Configured

Parameters:

property - a description for a configuration property

localizationContext - the localization context

Throws:

NoSuchElementException - on missing required properties

dump

public void dump(String description,
                 Logger logger,
                 com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Dumps all the properties as multiple log lines for debugging.

Parameters:

description - the meaning of this set of properties

logger - a logger used as output

localizationContext - the localization context