org.apache.ambari.server.topology

Class Configuration

java.lang.Object

org.apache.ambari.server.topology.Configuration

public class Configuration
extends Object

Configuration for a topology entity such as a blueprint, hostgroup or cluster.

Constructor Summary

Constructors

Constructor and Description
Configuration(Map<String,Map<String,String>> properties, Map<String,Map<String,Map<String,String>>> attributes) Configuration.
Configuration(Map<String,Map<String,String>> properties, Map<String,Map<String,Map<String,String>>> attributes, Configuration parentConfiguration) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<String>	applyUpdatesToStackDefaultProperties(Configuration stackDefaultConfig, Map<String,Map<String,String>> existingConfigurations, Map<String,Map<String,String>> updatedConfigs) Apply configuration changes from updatedConfigs to config, but only change properties that are either absent in the existing config, or have values that match the stack default config.
org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>>	asPair()
boolean	containsConfig(String configType, String propertyName)
boolean	containsConfigType(String configType)
Configuration	copy()
boolean	equals(Object obj)
Collection<String>	getAllConfigTypes() Get the complete set of configuration types represented in both full properties and full attributes.
Map<String,Map<String,Map<String,String>>>	getAttributes() Get the attributes for this instance only; parent attributes aren't included.
String	getAttributeValue(String configType, String propertyName, String attributeName) Get the requested attribute value from the full merged set of attributes.
Map<String,Map<String,Map<String,String>>>	getFullAttributes() Get a complete merged map of attributes including this instance and the entire parent hierarchy.
Map<String,Map<String,String>>	getFullProperties() Get a complete merged map of properties including this instance and the entire parent hierarchy.
Map<String,Map<String,String>>	getFullProperties(int depthLimit) Get a merged map of properties including this instance and n levels of the parent hierarchy.
Configuration	getParentConfiguration() Get the parent configuration.
Map<String,Map<String,String>>	getProperties() Get the properties for this instance only; parent properties are not included.
String	getPropertyValue(String configType, String propertyName) Get the requested property value from the full merged set of properties.
boolean	isPropertySet(String configType, String propertyName) General convenience method to determine if a given property has been set in the cluster configuration
Set<String>	moveProperties(String sourceConfigType, String targetConfigType, Set<String> propertiesToMove) Moves the given properties from sourceConfigType to targetConfigType.
static Configuration	newEmpty()
static Configuration	of(org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>> propertiesAndAttributes) Create a new Configuration based on a pair of maps.
void	removeConfigType(String configType) Remove all occurrences of a config type
String	removeProperty(String configType, String propertyName) Remove a property from the configuration hierarchy.
String	setAttribute(String configType, String propertyName, String attributeName, String attributeValue) Set an attribute on the hierarchy.
void	setParentConfiguration(Configuration parent) Set the parent configuration.
String	setProperty(String configType, String propertyName, String value) Set a property on the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(Map<String,Map<String,String>> properties,
                     Map<String,Map<String,Map<String,String>>> attributes,
                     Configuration parentConfiguration)

Constructor.

Parameters:

properties - properties

attributes - attributes

parentConfiguration - parent configuration

Configuration

public Configuration(Map<String,Map<String,String>> properties,
                     Map<String,Map<String,Map<String,String>>> attributes)

Configuration.

Parameters:

properties - properties in configType -> propertyName -> value format

attributes - attributes in configType -> attributeName -> propertyName -> attributeValue format

Method Detail

newEmpty

public static Configuration newEmpty()

applyUpdatesToStackDefaultProperties

public Set<String> applyUpdatesToStackDefaultProperties(Configuration stackDefaultConfig,
                                                        Map<String,Map<String,String>> existingConfigurations,
                                                        Map<String,Map<String,String>> updatedConfigs)

Apply configuration changes from updatedConfigs to config, but only change properties that are either absent in the existing config, or have values that match the stack default config.

Returns:

config types that had any updates applied

copy

public Configuration copy()

getProperties

public Map<String,Map<String,String>> getProperties()

Get the properties for this instance only; parent properties are not included.

Returns:

map of properties for this configuration instance keyed by config type

getFullProperties

public Map<String,Map<String,String>> getFullProperties()

Get a complete merged map of properties including this instance and the entire parent hierarchy. Properties are merged so that children override the same property specified in it's parent hierarchy. This result is re-calculated for each request in case a parent value has changed so the result should be cached if possible.

Returns:

complete map of merged properties keyed by config type

getFullProperties

public Map<String,Map<String,String>> getFullProperties(int depthLimit)

Get a merged map of properties including this instance and n levels of the parent hierarchy. Properties are merged so that children override the same property specified in it's parent hierarchy. This result is re-calculated for each request in case a parent value has changed so the result should be cached if possible.

Parameters:

depthLimit - the number of parent levels to include in the results. Specifying 0 is the same as calling getProperties()

Returns:

map of merged properties keyed by config type

getAttributes

public Map<String,Map<String,Map<String,String>>> getAttributes()

Get the attributes for this instance only; parent attributes aren't included.

Returns:

map of attributes {configType -> {attributeName -> {propName, attributeValue}}}

getFullAttributes

public Map<String,Map<String,Map<String,String>>> getFullAttributes()

Get a complete merged map of attributes including this instance and the entire parent hierarchy. Attributes are merged so that children override the same attribute specified in it's parent hierarchy. This result is re-calculated for each request in case a parent value has changed so the result should be cached if possible.

Returns:

complete map of merged attributes {configType -> {attributeName -> {propName, attributeValue}}}

getPropertyValue

public String getPropertyValue(String configType,
                               String propertyName)

Get the requested property value from the full merged set of properties.

Parameters:

configType - configuration type

propertyName - property name

Returns:

requested property value or null if property isn't set in configuration hierarchy

getAttributeValue

public String getAttributeValue(String configType,
                                String propertyName,
                                String attributeName)

Get the requested attribute value from the full merged set of attributes.

Parameters:

configType - configuration type

propertyName - attribute property name

attributeName - attribute name

Returns:

requested attribute value or null if the attribute isn't set in configuration hierarchy

setProperty

public String setProperty(String configType,
                          String propertyName,
                          String value)

Set a property on the configuration. The property will be set on this instance so it will override any value specified in the parent hierarchy.

Parameters:

configType - configuration type

propertyName - property name

value - property value

Returns:

the previous value of the property or null if it didn't exist

removeProperty

public String removeProperty(String configType,
                             String propertyName)

Remove a property from the configuration hierarchy. All occurrences of the property are removed from the config hierarchy such that a subsequent call to getPropertyValue() for the removed property will return null.

Parameters:

configType - configuration type

propertyName - property name

Returns:

the previous value of the removed property or null if it didn't exist in the configuration hierarchy

moveProperties

public Set<String> moveProperties(String sourceConfigType,
                                  String targetConfigType,
                                  Set<String> propertiesToMove)

Moves the given properties from sourceConfigType to targetConfigType. If a property is already present in the target, it will be removed from the source, but not overwritten in the target.

Parameters:

sourceConfigType - the config type to move properties from

targetConfigType - the config type to move properties to

propertiesToMove - names of properties to be moved

Returns:

property names that were removed from the source

isPropertySet

public boolean isPropertySet(String configType,
                             String propertyName)

General convenience method to determine if a given property has been set in the cluster configuration

Parameters:

configType - the config type to check

propertyName - the property name to check

Returns:

true if the named property has been set false if the named property has not been set

setAttribute

public String setAttribute(String configType,
                           String propertyName,
                           String attributeName,
                           String attributeValue)

Set an attribute on the hierarchy. The attribute will be set on this instance so it will override any value specified in the parent hierarchy.

Parameters:

configType - configuration type

propertyName - attribute property name

attributeName - attribute name

attributeValue - attribute property value

Returns:

the previous value of the attribute or null if it didn't exist

getAllConfigTypes

public Collection<String> getAllConfigTypes()

Get the complete set of configuration types represented in both full properties and full attributes.

Returns:

collection of all represented configuration types

containsConfigType

public boolean containsConfigType(String configType)

containsConfig

public boolean containsConfig(String configType,
                              String propertyName)

getParentConfiguration

public Configuration getParentConfiguration()

Get the parent configuration.

Returns:

the parent configuration or null if no parent is set

setParentConfiguration

public void setParentConfiguration(Configuration parent)

Set the parent configuration.

Parameters:

parent - parent configuration to set

removeConfigType

public void removeConfigType(String configType)

Remove all occurrences of a config type

of

public static Configuration of(org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>> propertiesAndAttributes)

Create a new Configuration based on a pair of maps. (This is just a convenience method to be able to avoid local variables in a few places.)

asPair

public org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>> asPair()

Returns:

this configuration's properties and attributes as a pair of maps, in order to be able to pass around more easily without polluting non-topology code with the Configuration object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object