org.apache.ambari.server.controller.internal

Class AmbariServerConfigurationHandler

java.lang.Object

org.apache.ambari.server.controller.internal.AmbariServerConfigurationHandler

Direct Known Subclasses:

AmbariServerLDAPConfigurationHandler, AmbariServerSSOConfigurationHandler

public class AmbariServerConfigurationHandler
extends Object

AmbariServerConfigurationHandler handles Ambari server specific configuration properties.

Method Summary

Modifier and Type	Method and Description
Map<String,RootServiceComponentConfiguration>	getComponentConfigurations(String categoryName) Retrieve the requested component configurations.
Map<String,String>	getConfigurationProperties(String categoryName) Get the properties associated with a configuration category
Map<String,Map<String,String>>	getConfigurations()
protected Set<String>	getEnabledServices(String categoryName, String manageServicesConfigurationPropertyName, String enabledServicesPropertyName)
org.apache.ambari.server.controller.internal.RootServiceComponentConfigurationHandler.OperationResult	performOperation(String categoryName, Map<String,String> properties, boolean mergeExistingProperties, String operation, Map<String,Object> operationParameters) Preform some operation on the set of data for a category.
void	removeComponentConfiguration(String categoryName) Delete the requested configuration.
void	updateComponentCategory(String categoryName, Map<String,String> properties, boolean removePropertiesIfNotSpecified) Set or update a configuration category with the specified properties.

Methods inherited from class java.lang.Object

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

Method Detail

getComponentConfigurations

public Map<String,RootServiceComponentConfiguration> getComponentConfigurations(String categoryName)

Retrieve the requested component configurations.

Parameters:

categoryName - the category name (or null for all)

Returns:

a map of category names to properties (name/value pairs).

removeComponentConfiguration

public void removeComponentConfiguration(String categoryName)

Delete the requested configuration.

Parameters:

categoryName - the category name

updateComponentCategory

public void updateComponentCategory(String categoryName,
                                    Map<String,String> properties,
                                    boolean removePropertiesIfNotSpecified)
                             throws org.apache.ambari.server.AmbariException

Set or update a configuration category with the specified properties.

If removePropertiesIfNotSpecified is true, the persisted category is to include only the specified properties.

If removePropertiesIfNotSpecified is false, the persisted category is to include the union of the existing and specified properties.

In any case, existing property values will be overwritten by the one specified in the property map.

Parameters:

categoryName - the category name

properties - a map of properties to set

removePropertiesIfNotSpecified - true to ensure the set of properties are only those that have be explicitly specified; false to update the set of existing properties with the specified set of properties, adding missing properties but not removing any properties

Throws:

org.apache.ambari.server.AmbariException - in case an error occurred while updating category's properties

performOperation

public org.apache.ambari.server.controller.internal.RootServiceComponentConfigurationHandler.OperationResult performOperation(String categoryName,
                                                                                                                              Map<String,String> properties,
                                                                                                                              boolean mergeExistingProperties,
                                                                                                                              String operation,
                                                                                                                              Map<String,Object> operationParameters)
                                                                                                                       throws SystemException

Preform some operation on the set of data for a category.

If mergeExistingProperties is false, the operation is to include the union of the existing and specified properties.

If mergeExistingProperties is false, the operation is to include only the specified properties.

Parameters:

categoryName - the category name

properties - a map of properties to set

mergeExistingProperties - true to use the the set of existing properties along with the specified set of properties; false to use set of specified properties only

operation - the operation to perform

operationParameters - parameters to supply the name operation

Returns:

an OperationResult

Throws:

SystemException - if an error occurs while handling the request

getConfigurations

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

getConfigurationProperties

public Map<String,String> getConfigurationProperties(String categoryName)

Get the properties associated with a configuration category

Parameters:

categoryName - the name of the requested category

Returns:

a map of property names to values; or null if the data does not exist

getEnabledServices

protected Set<String> getEnabledServices(String categoryName,
                                         String manageServicesConfigurationPropertyName,
                                         String enabledServicesPropertyName)