org.apache.ambari.server.configuration

Class AmbariServerConfiguration

java.lang.Object

org.apache.ambari.server.configuration.AmbariServerConfiguration

Direct Known Subclasses:

AmbariLdapConfiguration, AmbariTProxyConfiguration, JwtAuthenticationProperties

public abstract class AmbariServerConfiguration
extends Object

AmbariServerConfiguration is an abstract class to be extended by Ambari server configuration classes that encapsulate difference configuration categories such as 'ldap-configuration' and 'sso-configuration'.

See Also:

AmbariServerConfigurationCategory, AmbariServerConfigurationKey

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	configurationMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AmbariServerConfiguration(Map<String,String> configurationMap)

Method Summary

Modifier and Type	Method and Description
protected abstract AmbariServerConfigurationCategory	getCategory()
protected String	getValue(AmbariServerConfigurationKey ambariServerConfigurationKey, Map<String,String> configurationMap) Gets the configuration value for given AmbariServerConfigurationKey.
protected String	getValue(String propertyName, Map<String,String> configurationMap, String defaultValue) Gets the configuration value for given AmbariServerConfigurationKey.
void	setValueFor(AmbariServerConfigurationKey ambariServerConfigurationKey, String value) Sets the given value for the given configuration
void	setValueFor(String configName, String value) Sets the given value for the given configuration
Map<String,String>	toMap()

Methods inherited from class java.lang.Object

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

Field Detail

configurationMap

protected final Map<String,String> configurationMap

Constructor Detail

AmbariServerConfiguration

protected AmbariServerConfiguration(Map<String,String> configurationMap)

Method Detail

getValue

protected String getValue(AmbariServerConfigurationKey ambariServerConfigurationKey,
                          Map<String,String> configurationMap)

Gets the configuration value for given AmbariServerConfigurationKey.

If no value is found in the supplied configuration map, the default value will be returned.

Parameters:

ambariServerConfigurationKey - the AmbariServerConfigurationKey for which to retrieve a value

configurationMap - a map of configuration property names to values

Returns:

the requested configuration value

getValue

protected String getValue(String propertyName,
                          Map<String,String> configurationMap,
                          String defaultValue)

Gets the configuration value for given AmbariServerConfigurationKey.

If no value is found in the supplied configuration map, the default value will be returned.

Parameters:

propertyName - the property name for which to retrieve a value

configurationMap - a map of configuration property names to values

defaultValue - the default value to use in the event the propery was not set in the configuration map

Returns:

the requested configuration value

toMap

public Map<String,String> toMap()

Returns:

this configuration represented as a map

setValueFor

public void setValueFor(String configName,
                        String value)

Sets the given value for the given configuration

Parameters:

configName - the name of the configuration to set the value for

value - the new value

Throws:

IllegalArgumentException - in case the supplied configuration does not belong to the configuration category of this instance

setValueFor

public void setValueFor(AmbariServerConfigurationKey ambariServerConfigurationKey,
                        String value)

Sets the given value for the given configuration

Parameters:

ambariServerConfigurationKey - the configuration key to set the value for

value - the new value

Throws:

IllegalArgumentException - in case the supplied configuration does not belong to the configuration category of this instance

getCategory

protected abstract AmbariServerConfigurationCategory getCategory()