org.apache.ambari.server.state

Class ConfigHelper

java.lang.Object

org.apache.ambari.server.state.ConfigHelper

public class ConfigHelper
extends Object

Helper class that works with config traversals.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_DEFAULT_TAG
static String	CLUSTER_ENV
static String	CLUSTER_ENV_ALERT_REPEAT_TOLERANCE
static String	CLUSTER_ENV_RETRY_COMMANDS
static String	CLUSTER_ENV_RETRY_ENABLED
static String	CLUSTER_ENV_RETRY_MAX_TIME_IN_SEC
static String	CLUSTER_ENV_STACK_FEATURES_PROPERTY
static String	CLUSTER_ENV_STACK_NAME_PROPERTY
static String	CLUSTER_ENV_STACK_PACKAGES_PROPERTY
static String	CLUSTER_ENV_STACK_ROOT_PROPERTY
static String	CLUSTER_ENV_STACK_TOOLS_PROPERTY
static String	COMMAND_RETRY_MAX_TIME_IN_SEC_DEFAULT
static String	FIRST_VERSION_TAG The tag given to newly created versions.
static String	HBASE_SITE List of property prefixes and names.
static String	HDFS_SITE
static String	HIVE_SITE
static String	HTTP_ONLY
static String	HTTPS_ONLY
static String	SERVICE_CHECK_MINIMAL
static String	SERVICE_CHECK_TYPE
static String	YARN_SITE

Constructor Summary

Constructors

Constructor and Description
ConfigHelper(Clusters c, AmbariMetaInfo metaInfo, Configuration configuration, ClusterDAO clusterDAO)

Method Summary

Modifier and Type	Method and Description
void	applyCustomConfig(Map<String,Map<String,String>> configurations, String type, String name, String value, Boolean deleted)
org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>>	calculateExistingConfigs(Cluster cluster) Determines the existing configurations for the cluster, both properties and attributes.
Map<String,Map<String,String>>	calculateExistingConfigurations(AmbariManagementController ambariManagementController, Cluster cluster) Determines the existing configurations for the cluster
Map<String,Map<String,String>>	calculateExistingConfigurations(AmbariManagementController ambariManagementController, Cluster cluster, String hostname) Determines the existing configurations for the cluster, related to a given hostname (if provided)
void	checkAllStageConfigsPresentInDesiredConfigs(Cluster cluster)
boolean	checkStaleConfigsStatusForHostComponent(ServiceComponentHost sch, Map<String,Collection<String>> changedConfigs) Checks configs are stale for specified host component.
void	checkStaleConfigsStatusOnConfigsUpdate(Long clusterId, String serviceName, Map<Long,Map<String,Collection<String>>> changedConfigs) Checks configs are stale after specified config changes for service's components.
void	cloneAttributesMap(Map<String,Map<String,String>> sourceAttributesMap, Map<String,Map<String,String>> targetAttributesMap)
boolean	createConfigType(Cluster cluster, StackId stackId, AmbariManagementController controller, String configType, Map<String,String> properties, Map<String,Map<String,String>> propertyAttributes, String authenticatedUserName, String serviceVersionNote)
void	createConfigType(Cluster cluster, StackId stackId, AmbariManagementController controller, String configType, Map<String,String> properties, String authenticatedUserName, String serviceVersionNote)
boolean	createConfigTypes(Cluster cluster, StackId stackId, AmbariManagementController controller, Map<String,Map<String,String>> batchProperties, String authenticatedUserName, String serviceVersionNote) Create configurations and assign them for services.
Map<String,Set<String>>	createUserGroupsMap(Cluster cluster, Map<String,DesiredConfig> desiredConfigs, Map<String,ServiceInfo> servicesMap, Set<PropertyInfo> stackProperties) Fetch user to group mapping from the cluster configs.
Map<String,Set<String>>	createUserGroupsMap(StackId stackId, Cluster cluster, Map<String,DesiredConfig> desiredConfigs) Fetch user to group mapping from the cluster configs.
static String	fileNameToConfigType(String filename)
Set<String>	filterInvalidPropertyValues(Map<PropertyInfo,String> properties, String filteredListName)
Set<String>	findConfigTypesByPropertyName(StackId stackId, String propertyName, String clusterName) Gets all the config dictionary where property with the given name is present in stack definitions
void	getAndMergeHostConfigAttributes(Map<String,Map<String,Map<String,String>>> configurationAttributes, Map<String,Map<String,String>> configurationTags, Cluster cluster) Retrieves effective configuration attributes for specified cluster and tags and merge them with present before in configurationAttributes
void	getAndMergeHostConfigs(Map<String,Map<String,String>> configurations, Map<String,Map<String,String>> configurationTags, Cluster cluster) Retrieves effective configurations for specified cluster and tags and merge them with present before in configurations
Map<String,Collection<String>>	getChangedConfigTypes(Cluster cluster, ServiceConfigEntity currentServiceConfigEntity, Long configGroupId, Long clusterId, String serviceName) Calculates config types and keys were changed during configs change.
Map<String,Map<String,String>>	getCredentialStoreEnabledProperties(StackId stackId, Service service) Gets a map of config types to password property names to password property value names, that are credential store enabled.
Map<String,Map<String,String>>	getDefaultProperties(StackId stack, String serviceName)
Map<String,Map<String,String>>	getDefaultStackProperties(StackId stack) Gets the default properties for the specified service.
Map<String,Map<String,Map<String,String>>>	getEffectiveConfigAttributes(Cluster cluster, Map<String,Map<String,String>> desiredTags) Get all config attributes for a cluster given a set of configType to versionTags map.
Map<String,Map<String,String>>	getEffectiveConfigProperties(Cluster cluster, Map<String,Map<String,String>> desiredTags) Get all config properties for a cluster given a set of configType to versionTags map.
Map<String,Map<String,String>>	getEffectiveConfigProperties(String clusterName, String hostName)
Map<String,Map<String,String>>	getEffectiveDesiredTags(Cluster cluster, String hostName) Gets the desired tags for a cluster and host
Map<String,Map<String,String>>	getEffectiveDesiredTags(Cluster cluster, String hostName, Map<String,DesiredConfig> desiredConfigs) Gets the desired tags for a cluster and host
AgentConfigsUpdateEvent	getHostActualConfigs(Long hostId) Collects actual configurations and configuration attributes for specified host.
AgentConfigsUpdateEvent	getHostActualConfigsExcludeCluster(Long hostId, Long clusterId)
Map<String,String>	getMergedConfig(Map<String,String> persistedClusterConfig, Map<String,String> override) Merge override with original, if original property doesn't exist, add it to the properties
String	getPlaceholderValueFromDesiredConfigurations(Cluster cluster, String placeholder) Gets the configuration value referenced by the specified placeholder from the cluster configuration.
Map<PropertyInfo,String>	getPropertiesWithPropertyType(PropertyInfo.PropertyType propertyType, Cluster cluster, Map<String,DesiredConfig> desiredConfigs, Map<String,ServiceInfo> servicesMap, Set<PropertyInfo> stackProperties) Fetch all the properties of a given PropertyType.
Map<PropertyInfo,String>	getPropertiesWithPropertyType(StackId stackId, PropertyInfo.PropertyType propertyType, Cluster cluster, Map<String,DesiredConfig> desiredConfigs) Fetch all the properties of a given PropertyType.
ServiceInfo	getPropertyOwnerService(Cluster cluster, String configType, String propertyName)
String	getPropertyValueFromStackDefinitions(Cluster cluster, String configType, String propertyName) Fetch all the config values of a given PropertyType.
Set<String>	getPropertyValuesWithPropertyType(PropertyInfo.PropertyType propertyType, Cluster cluster, Map<String,DesiredConfig> desiredConfigs, Map<String,ServiceInfo> servicesMap, Set<PropertyInfo> stackProperties) Fetch all the property values of a given PropertyType.
Set<String>	getPropertyValuesWithPropertyType(StackId stackId, PropertyInfo.PropertyType propertyType, Cluster cluster, Map<String,DesiredConfig> desiredConfigs) Fetch all the property values of a given PropertyType.
String	getRefreshConfigsCommand(Cluster cluster, ServiceComponentHost sch)
String	getRefreshConfigsCommand(Cluster cluster, String hostName, String serviceName, String componentName)
Set<PropertyInfo>	getServiceProperties(Cluster cluster, String serviceName)
Set<PropertyInfo>	getServiceProperties(StackId stackId, String serviceName, boolean removeExcluded) Retrieves a Set of PropertyInfo objects containing the relevant properties for the requested service.
Set<PropertyInfo>	getStackProperties(Cluster cluster)
String	getValueFromDesiredConfigurations(Cluster cluster, String configType, String propertyName)
boolean	isStaleConfigs(ServiceComponentHost sch, Map<String,DesiredConfig> requestDesiredConfigs) The purpose of this method is to determine if a ServiceComponentHost's known actual configs are different than what is set on the cluster (the desired).
boolean	isStaleConfigs(ServiceComponentHost sch, Map<String,DesiredConfig> requestDesiredConfigs, HostComponentDesiredStateEntity hostComponentDesiredStateEntity)
static void	mergeConfigAttributes(Map<String,Map<String,String>> attributes, Map<String,Map<String,String>> additionalAttributes) Merge one attribute map to another.
Map<String,Map<String,String>>	overrideAttributes(Config overrideConfig, Map<String,Map<String,String>> persistedAttributes) Merge override attributes with original ones.
static void	processHiddenAttribute(Map<String,Map<String,String>> configurations, Map<String,Map<String,Map<String,String>>> attributes, String componentName, boolean configDownload) Removes properties from configurations that marked as hidden for specified component.
void	removeConfigsByType(Cluster cluster, String type) Remove configs by type
SortedMap<String,SortedMap<String,SortedMap<String,String>>>	sortConfigurationAttributes(Map<String,Map<String,Map<String,String>>> configurationAttributes)
SortedMap<String,SortedMap<String,String>>	sortConfigutations(Map<String,Map<String,String>> configurations)
void	updateAgentConfigs(Set<String> updatedClusters) Checks populated services for staled configs and updates agent configs.
void	updateConfigType(Cluster cluster, StackId stackId, AmbariManagementController controller, String configType, Map<String,String> updates, Collection<String> removals, String authenticatedUserName, String serviceVersionNote) A helper method to create a new Config for a given configuration type and updates to the current values, if any.
boolean	wasStaleConfigsStatusUpdated(Long clusterId, Long hostId, String serviceName, String hostComponentName, Boolean staleConfigs) Tries to change cached stale config with new value.

Methods inherited from class java.lang.Object

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

Field Detail

CLUSTER_DEFAULT_TAG

public static final String CLUSTER_DEFAULT_TAG

See Also:

Constant Field Values

HBASE_SITE

public static final String HBASE_SITE

List of property prefixes and names. Please keep in alphabetical order.

See Also:

Constant Field Values

HDFS_SITE

public static final String HDFS_SITE

See Also:

Constant Field Values

HIVE_SITE

public static final String HIVE_SITE

See Also:

Constant Field Values

YARN_SITE

public static final String YARN_SITE

See Also:

Constant Field Values

CLUSTER_ENV

public static final String CLUSTER_ENV

See Also:

Constant Field Values

CLUSTER_ENV_ALERT_REPEAT_TOLERANCE

public static final String CLUSTER_ENV_ALERT_REPEAT_TOLERANCE

See Also:

Constant Field Values

CLUSTER_ENV_RETRY_ENABLED

public static final String CLUSTER_ENV_RETRY_ENABLED

See Also:

Constant Field Values

SERVICE_CHECK_TYPE

public static final String SERVICE_CHECK_TYPE

See Also:

Constant Field Values

CLUSTER_ENV_RETRY_COMMANDS

public static final String CLUSTER_ENV_RETRY_COMMANDS

See Also:

Constant Field Values

CLUSTER_ENV_RETRY_MAX_TIME_IN_SEC

public static final String CLUSTER_ENV_RETRY_MAX_TIME_IN_SEC

See Also:

Constant Field Values

COMMAND_RETRY_MAX_TIME_IN_SEC_DEFAULT

public static final String COMMAND_RETRY_MAX_TIME_IN_SEC_DEFAULT

See Also:

Constant Field Values

CLUSTER_ENV_STACK_NAME_PROPERTY

public static final String CLUSTER_ENV_STACK_NAME_PROPERTY

See Also:

Constant Field Values

CLUSTER_ENV_STACK_FEATURES_PROPERTY

public static final String CLUSTER_ENV_STACK_FEATURES_PROPERTY

See Also:

Constant Field Values

CLUSTER_ENV_STACK_TOOLS_PROPERTY

public static final String CLUSTER_ENV_STACK_TOOLS_PROPERTY

See Also:

Constant Field Values

CLUSTER_ENV_STACK_ROOT_PROPERTY

public static final String CLUSTER_ENV_STACK_ROOT_PROPERTY

See Also:

Constant Field Values

CLUSTER_ENV_STACK_PACKAGES_PROPERTY

public static final String CLUSTER_ENV_STACK_PACKAGES_PROPERTY

See Also:

Constant Field Values

HTTP_ONLY

public static final String HTTP_ONLY

See Also:

Constant Field Values

HTTPS_ONLY

public static final String HTTPS_ONLY

See Also:

Constant Field Values

SERVICE_CHECK_MINIMAL

public static final String SERVICE_CHECK_MINIMAL

See Also:

Constant Field Values

FIRST_VERSION_TAG

public static final String FIRST_VERSION_TAG

The tag given to newly created versions.

See Also:

Constant Field Values

Constructor Detail

ConfigHelper

@Inject
public ConfigHelper(Clusters c,
                            AmbariMetaInfo metaInfo,
                            Configuration configuration,
                            ClusterDAO clusterDAO)

Method Detail

getEffectiveDesiredTags

public Map<String,Map<String,String>> getEffectiveDesiredTags(Cluster cluster,
                                                              String hostName)
                                                       throws org.apache.ambari.server.AmbariException

Gets the desired tags for a cluster and host

Parameters:

cluster - the cluster

hostName - the host name

Returns:

a map of tag type to tag names with overrides

Throws:

org.apache.ambari.server.AmbariException

getEffectiveDesiredTags

public Map<String,Map<String,String>> getEffectiveDesiredTags(Cluster cluster,
                                                              String hostName,
                                                              Map<String,DesiredConfig> desiredConfigs)
                                                       throws org.apache.ambari.server.AmbariException

Gets the desired tags for a cluster and host

Parameters:

cluster - the cluster

hostName - the host name

Returns:

a map of tag type to tag names with overrides

Throws:

org.apache.ambari.server.AmbariException

filterInvalidPropertyValues

public Set<String> filterInvalidPropertyValues(Map<PropertyInfo,String> properties,
                                               String filteredListName)

getEffectiveConfigProperties

public Map<String,Map<String,String>> getEffectiveConfigProperties(Cluster cluster,
                                                                   Map<String,Map<String,String>> desiredTags)

Get all config properties for a cluster given a set of configType to versionTags map. This helper method merges all the override tags with a the properties from parent cluster config properties

Parameters:

cluster -

desiredTags -

Returns:

{type : {key, value}}

getEffectiveConfigProperties

public Map<String,Map<String,String>> getEffectiveConfigProperties(String clusterName,
                                                                   String hostName)
                                                            throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getEffectiveConfigAttributes

public Map<String,Map<String,Map<String,String>>> getEffectiveConfigAttributes(Cluster cluster,
                                                                               Map<String,Map<String,String>> desiredTags)

Get all config attributes for a cluster given a set of configType to versionTags map. This helper method merges all the override tags with a the attributes from parent cluster config properties

Parameters:

cluster -

desiredTags -

Returns:

{type : {attribute : {property, attributeValue}}

getMergedConfig

public Map<String,String> getMergedConfig(Map<String,String> persistedClusterConfig,
                                          Map<String,String> override)

Merge override with original, if original property doesn't exist, add it to the properties

Parameters:

persistedClusterConfig -

override -

Returns:

getAndMergeHostConfigs

public void getAndMergeHostConfigs(Map<String,Map<String,String>> configurations,
                                   Map<String,Map<String,String>> configurationTags,
                                   Cluster cluster)

Retrieves effective configurations for specified cluster and tags and merge them with present before in configurations

Parameters:

configurations - configurations will be merged with effective cluster configurations

configurationTags - configuration tags for cluster's desired configs

cluster - cluster to configs retrieving

getAndMergeHostConfigAttributes

public void getAndMergeHostConfigAttributes(Map<String,Map<String,Map<String,String>>> configurationAttributes,
                                            Map<String,Map<String,String>> configurationTags,
                                            Cluster cluster)

Retrieves effective configuration attributes for specified cluster and tags and merge them with present before in configurationAttributes

Parameters:

configurationAttributes - configuration attributes will be merged with effective ones on the cluster

configurationTags - configuration tags for cluster's desired configs

cluster - cluster to config attributes retrieving

overrideAttributes

public Map<String,Map<String,String>> overrideAttributes(Config overrideConfig,
                                                         Map<String,Map<String,String>> persistedAttributes)

Merge override attributes with original ones. If overrideConfig#getPropertiesAttributes does not contain occurrence of override for any of properties from overrideConfig#getProperties then persisted attribute should be removed.

cloneAttributesMap

public void cloneAttributesMap(Map<String,Map<String,String>> sourceAttributesMap,
                               Map<String,Map<String,String>> targetAttributesMap)

applyCustomConfig

public void applyCustomConfig(Map<String,Map<String,String>> configurations,
                              String type,
                              String name,
                              String value,
                              Boolean deleted)

isStaleConfigs

public boolean isStaleConfigs(ServiceComponentHost sch,
                              Map<String,DesiredConfig> requestDesiredConfigs)
                       throws org.apache.ambari.server.AmbariException

The purpose of this method is to determine if a ServiceComponentHost's known actual configs are different than what is set on the cluster (the desired). The following logic is applied:

• Desired type does not exist on the SCH (actual)
  • Type does not exist on the stack: false
  • Type exists on the stack: true if the config key is on the stack. otherwise false
• Desired type exists for the SCH
  • Desired tags already set for the SCH (actual): false
  • Desired tags DO NOT match SCH: true if the changed keys exist on the stack, otherwise false

Parameters:

sch - the SCH to calcualte config staleness for (not null).

requestDesiredConfigs - the desired configurations for the cluster. Obtaining these can be expensive and since this method operates on SCH's, it could be called 10,000's of times when generating cluster/host responses. Therefore, the caller should build these once and pass them in. If null, then this method will retrieve them at runtime, incurring a performance penality.

Returns:

true if the actual configs are stale

Throws:

org.apache.ambari.server.AmbariException

isStaleConfigs

public boolean isStaleConfigs(ServiceComponentHost sch,
                              Map<String,DesiredConfig> requestDesiredConfigs,
                              HostComponentDesiredStateEntity hostComponentDesiredStateEntity)
                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

removeConfigsByType

public void removeConfigsByType(Cluster cluster,
                                String type)

Remove configs by type

Parameters:

type - config Type

findConfigTypesByPropertyName

public Set<String> findConfigTypesByPropertyName(StackId stackId,
                                                 String propertyName,
                                                 String clusterName)
                                          throws org.apache.ambari.server.AmbariException

Gets all the config dictionary where property with the given name is present in stack definitions

Parameters:

stackId -

propertyName -

Throws:

org.apache.ambari.server.AmbariException

getCredentialStoreEnabledProperties

public Map<String,Map<String,String>> getCredentialStoreEnabledProperties(StackId stackId,
                                                                          Service service)
                                                                   throws org.apache.ambari.server.AmbariException

Gets a map of config types to password property names to password property value names, that are credential store enabled.

Parameters:

stackId -

service -

Returns:

Throws:

org.apache.ambari.server.AmbariException

createUserGroupsMap

public Map<String,Set<String>> createUserGroupsMap(StackId stackId,
                                                   Cluster cluster,
                                                   Map<String,DesiredConfig> desiredConfigs)
                                            throws org.apache.ambari.server.AmbariException

Fetch user to group mapping from the cluster configs. UserGroupEntries contain information regarding the group that the user is associated to.

Parameters:

stackId -

cluster -

desiredConfigs -

Returns:

Throws:

org.apache.ambari.server.AmbariException

createUserGroupsMap

public Map<String,Set<String>> createUserGroupsMap(Cluster cluster,
                                                   Map<String,DesiredConfig> desiredConfigs,
                                                   Map<String,ServiceInfo> servicesMap,
                                                   Set<PropertyInfo> stackProperties)
                                            throws org.apache.ambari.server.AmbariException

Fetch user to group mapping from the cluster configs. UserGroupEntries contain information regarding the group that the user is associated to.

Parameters:

cluster -

desiredConfigs -

servicesMap -

stackProperties -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPropertiesWithPropertyType

public Map<PropertyInfo,String> getPropertiesWithPropertyType(StackId stackId,
                                                              PropertyInfo.PropertyType propertyType,
                                                              Cluster cluster,
                                                              Map<String,DesiredConfig> desiredConfigs)
                                                       throws org.apache.ambari.server.AmbariException

Fetch all the properties of a given PropertyType. For eg: Fetch all cluster configs that are of type "user"

Parameters:

stackId -

propertyType -

cluster -

desiredConfigs -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPropertiesWithPropertyType

public Map<PropertyInfo,String> getPropertiesWithPropertyType(PropertyInfo.PropertyType propertyType,
                                                              Cluster cluster,
                                                              Map<String,DesiredConfig> desiredConfigs,
                                                              Map<String,ServiceInfo> servicesMap,
                                                              Set<PropertyInfo> stackProperties)
                                                       throws org.apache.ambari.server.AmbariException

Fetch all the properties of a given PropertyType. For eg: Fetch all cluster configs that are of type "user"

Parameters:

propertyType -

cluster -

desiredConfigs -

servicesMap -

stackProperties -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPropertyValuesWithPropertyType

public Set<String> getPropertyValuesWithPropertyType(StackId stackId,
                                                     PropertyInfo.PropertyType propertyType,
                                                     Cluster cluster,
                                                     Map<String,DesiredConfig> desiredConfigs)
                                              throws org.apache.ambari.server.AmbariException

Fetch all the property values of a given PropertyType. For eg: Fetch all cluster configs that are of type "user"

Parameters:

stackId -

propertyType -

cluster -

desiredConfigs -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPropertyValuesWithPropertyType

public Set<String> getPropertyValuesWithPropertyType(PropertyInfo.PropertyType propertyType,
                                                     Cluster cluster,
                                                     Map<String,DesiredConfig> desiredConfigs,
                                                     Map<String,ServiceInfo> servicesMap,
                                                     Set<PropertyInfo> stackProperties)
                                              throws org.apache.ambari.server.AmbariException

Fetch all the property values of a given PropertyType. For eg: Fetch all cluster configs that are of type "user"

Parameters:

propertyType -

cluster -

desiredConfigs -

servicesMap -

stackProperties -

Returns:

Throws:

org.apache.ambari.server.AmbariException

checkAllStageConfigsPresentInDesiredConfigs

public void checkAllStageConfigsPresentInDesiredConfigs(Cluster cluster)
                                                 throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getPropertyValueFromStackDefinitions

public String getPropertyValueFromStackDefinitions(Cluster cluster,
                                                   String configType,
                                                   String propertyName)
                                            throws org.apache.ambari.server.AmbariException

Fetch all the config values of a given PropertyType. For eg: Fetch all stack configs that are of type "user"

Parameters:

cluster -

configType -

propertyName -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPlaceholderValueFromDesiredConfigurations

public String getPlaceholderValueFromDesiredConfigurations(Cluster cluster,
                                                           String placeholder)

Gets the configuration value referenced by the specified placeholder from the cluster configuration. This will take a configuration placeholder such as {{hdfs-site/foo}} and return the value of foo defined in hdfs-site.

Parameters:

cluster - the cluster to use when rendering the placeholder value (not null).

placeholder - the placeholder value, such as {{hdfs-site/foobar}} (not null )

Returns:

the configuration value, or null if none.

Throws:

org.apache.ambari.server.AmbariException - if there was a problem parsing the placeholder or retrieving the referenced value.

getValueFromDesiredConfigurations

public String getValueFromDesiredConfigurations(Cluster cluster,
                                                String configType,
                                                String propertyName)

getPropertyOwnerService

public ServiceInfo getPropertyOwnerService(Cluster cluster,
                                           String configType,
                                           String propertyName)
                                    throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getServiceProperties

public Set<PropertyInfo> getServiceProperties(Cluster cluster,
                                              String serviceName)
                                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getServiceProperties

public Set<PropertyInfo> getServiceProperties(StackId stackId,
                                              String serviceName,
                                              boolean removeExcluded)
                                       throws org.apache.ambari.server.AmbariException

Retrieves a Set of PropertyInfo objects containing the relevant properties for the requested service.

If removeExcluded is true, the service's excluded configuration types are used to prune off PropertyInfos that should be ignored; else if false, all PropertyInfos will be returned.

Parameters:

stackId - a StackId declaring the relevant stack

serviceName - a String containing the requested service's name

removeExcluded - a boolean value indicating whether to remove properties from excluded configuration types (true) or return the complete set of properties regardless of exclusions (false)

Returns:

a Set of PropertyInfo objects for the requested service

Throws:

org.apache.ambari.server.AmbariException - if the requested stack or the requested service is not found

getStackProperties

public Set<PropertyInfo> getStackProperties(Cluster cluster)
                                     throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

updateConfigType

public void updateConfigType(Cluster cluster,
                             StackId stackId,
                             AmbariManagementController controller,
                             String configType,
                             Map<String,String> updates,
                             Collection<String> removals,
                             String authenticatedUserName,
                             String serviceVersionNote)
                      throws org.apache.ambari.server.AmbariException

A helper method to create a new Config for a given configuration type and updates to the current values, if any. This method will perform the following tasks:

• Merge the specified updates with the properties of the current version of the configuration
• Create a Config in the cluster for the specified type. This will have the proper versions and tags set automatically.
• Set the cluster's DesiredConfig to the new configuration
• Create an entry in the configuration history with a note and username.

Parameters:

cluster -

controller -

configType -

updates -

removals - a collection of property names to remove from the configuration type

authenticatedUserName -

serviceVersionNote -

Throws:

org.apache.ambari.server.AmbariException

createConfigType

public void createConfigType(Cluster cluster,
                             StackId stackId,
                             AmbariManagementController controller,
                             String configType,
                             Map<String,String> properties,
                             String authenticatedUserName,
                             String serviceVersionNote)
                      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

createConfigType

public boolean createConfigType(Cluster cluster,
                                StackId stackId,
                                AmbariManagementController controller,
                                String configType,
                                Map<String,String> properties,
                                Map<String,Map<String,String>> propertyAttributes,
                                String authenticatedUserName,
                                String serviceVersionNote)
                         throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

createConfigTypes

public boolean createConfigTypes(Cluster cluster,
                                 StackId stackId,
                                 AmbariManagementController controller,
                                 Map<String,Map<String,String>> batchProperties,
                                 String authenticatedUserName,
                                 String serviceVersionNote)
                          throws org.apache.ambari.server.AmbariException

Create configurations and assign them for services.

Parameters:

cluster - the cluster

controller - the controller

stackId - the stack to create the new properties for

batchProperties - the type->config map batch of properties

authenticatedUserName - the user that initiated the change

serviceVersionNote - the service version note

Returns:

true if configs were created

Throws:

org.apache.ambari.server.AmbariException

getDefaultStackProperties

public Map<String,Map<String,String>> getDefaultStackProperties(StackId stack)
                                                         throws org.apache.ambari.server.AmbariException

Gets the default properties for the specified service. These properties represent those which would be used when a service is first installed.

Parameters:

stack - the stack to pull stack-values from (not null)

Returns:

a mapping of configuration type to map of key/value pairs for the default configurations.

Throws:

org.apache.ambari.server.AmbariException

getDefaultProperties

public Map<String,Map<String,String>> getDefaultProperties(StackId stack,
                                                           String serviceName)
                                                    throws org.apache.ambari.server.AmbariException

Parameters:

stack - the stack to pull stack-values from (not null)

serviceName - the service name null).

Returns:

a mapping of configuration type to map of key/value pairs for the default configurations.

Throws:

org.apache.ambari.server.AmbariException

updateAgentConfigs

public void updateAgentConfigs(Set<String> updatedClusters)
                        throws org.apache.ambari.server.AmbariException

Checks populated services for staled configs and updates agent configs. Method retrieves actual agent configs and compares them with just generated to identify stale configs. Then config updates are sent to agents.

Parameters:

updatedClusters - names of clusters with changed configs

Throws:

org.apache.ambari.server.AmbariException

checkStaleConfigsStatusOnConfigsUpdate

public void checkStaleConfigsStatusOnConfigsUpdate(Long clusterId,
                                                   String serviceName,
                                                   Map<Long,Map<String,Collection<String>>> changedConfigs)
                                            throws org.apache.ambari.server.AmbariException

Checks configs are stale after specified config changes for service's components.

Parameters:

clusterId - cluster with changed config

serviceName - service for changed config

changedConfigs - map of config types to collections of changed properties' names.

Throws:

org.apache.ambari.server.AmbariException

wasStaleConfigsStatusUpdated

public boolean wasStaleConfigsStatusUpdated(Long clusterId,
                                            Long hostId,
                                            String serviceName,
                                            String hostComponentName,
                                            Boolean staleConfigs)

Tries to change cached stale config with new value.

Parameters:

clusterId - cluster id.

hostId - host id.

serviceName - service name.

hostComponentName - component name.

staleConfigs - value to check.

Returns:

true if value from cache is different from .

checkStaleConfigsStatusForHostComponent

public boolean checkStaleConfigsStatusForHostComponent(ServiceComponentHost sch,
                                                       Map<String,Collection<String>> changedConfigs)
                                                throws org.apache.ambari.server.AmbariException

Checks configs are stale for specified host component.

Parameters:

sch - host component to check.

changedConfigs - map of config types to collections of changed properties' names.

Returns:

true if configs are stale.

Throws:

org.apache.ambari.server.AmbariException

getChangedConfigTypes

public Map<String,Collection<String>> getChangedConfigTypes(Cluster cluster,
                                                            ServiceConfigEntity currentServiceConfigEntity,
                                                            Long configGroupId,
                                                            Long clusterId,
                                                            String serviceName)

Calculates config types and keys were changed during configs change.

Parameters:

currentServiceConfigEntity - service config entity with populated current cluster configs

configGroupId - id of config group contained changed configs. Can be null in case group is default

clusterId - cluster id

serviceName - service name configs were changed for

Returns:

map of type names to collections of properties' names were changed.

getRefreshConfigsCommand

public String getRefreshConfigsCommand(Cluster cluster,
                                       String hostName,
                                       String serviceName,
                                       String componentName)
                                throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getRefreshConfigsCommand

public String getRefreshConfigsCommand(Cluster cluster,
                                       ServiceComponentHost sch)
                                throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

fileNameToConfigType

public static String fileNameToConfigType(String filename)

processHiddenAttribute

public static void processHiddenAttribute(Map<String,Map<String,String>> configurations,
                                          Map<String,Map<String,Map<String,String>>> attributes,
                                          String componentName,
                                          boolean configDownload)

Removes properties from configurations that marked as hidden for specified component.

Parameters:

configurations - cluster configurations

attributes - configuration attributes

componentName - component name

configDownload - indicates if config must be downloaded

mergeConfigAttributes

public static void mergeConfigAttributes(Map<String,Map<String,String>> attributes,
                                         Map<String,Map<String,String>> additionalAttributes)

Merge one attribute map to another.

Parameters:

attributes - original map

additionalAttributes - map with additional attributes

getHostActualConfigs

public AgentConfigsUpdateEvent getHostActualConfigs(Long hostId)
                                             throws org.apache.ambari.server.AmbariException

Collects actual configurations and configuration attributes for specified host.

Parameters:

hostId - host id to collect configurations and configuration attributes

Returns:

event ready to send to agent

Throws:

org.apache.ambari.server.AmbariException

getHostActualConfigsExcludeCluster

public AgentConfigsUpdateEvent getHostActualConfigsExcludeCluster(Long hostId,
                                                                  Long clusterId)
                                                           throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

sortConfigutations

public SortedMap<String,SortedMap<String,String>> sortConfigutations(Map<String,Map<String,String>> configurations)

sortConfigurationAttributes

public SortedMap<String,SortedMap<String,SortedMap<String,String>>> sortConfigurationAttributes(Map<String,Map<String,Map<String,String>>> configurationAttributes)

calculateExistingConfigurations

public Map<String,Map<String,String>> calculateExistingConfigurations(AmbariManagementController ambariManagementController,
                                                                      Cluster cluster)
                                                               throws org.apache.ambari.server.AmbariException

Determines the existing configurations for the cluster

Parameters:

ambariManagementController - the Ambari management controller

cluster - the cluster

Returns:

a map of the existing configurations

Throws:

org.apache.ambari.server.AmbariException

calculateExistingConfigurations

public Map<String,Map<String,String>> calculateExistingConfigurations(AmbariManagementController ambariManagementController,
                                                                      Cluster cluster,
                                                                      String hostname)
                                                               throws org.apache.ambari.server.AmbariException

Determines the existing configurations for the cluster, related to a given hostname (if provided)

Parameters:

ambariManagementController - the Ambari management controller

cluster - the cluster

hostname - a hostname

Returns:

a map of the existing configurations

Throws:

org.apache.ambari.server.AmbariException

calculateExistingConfigs

public org.apache.commons.lang3.tuple.Pair<Map<String,Map<String,String>>,Map<String,Map<String,Map<String,String>>>> calculateExistingConfigs(Cluster cluster)
                                                                                                                                        throws org.apache.ambari.server.AmbariException

Determines the existing configurations for the cluster, both properties and attributes.

Throws:

org.apache.ambari.server.AmbariException