org.apache.ambari.server.controller.utilities

Class PropertyHelper

java.lang.Object

org.apache.ambari.server.controller.utilities.PropertyHelper

public class PropertyHelper
extends Object

Utility class that provides Property helper methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PropertyHelper.Metric

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	AGGREGATE_FUNCTION_IDENTIFIERS Aggregate functions implicitly supported by the Metrics Service
static char	EXTERNAL_PATH_SEP

Constructor Summary

Constructors

Constructor and Description
PropertyHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	containsArguments(String propertyId) Check to see if the given property id contains replacement arguments (e.g.
static boolean	containsProperty(Set<String> propertyIds, String propertyId) Check if the given property id or one of its parent category ids is contained in the given set of property ids.
static Set<String>	getAssociatedPropertyIds(Request request) Get all of the property ids associated with the given request.
static Set<String>	getCategories(Set<String> propertyIds) Get the set of categories for the given property ids.
static Request	getCreateRequest(Set<Map<String,Object>> properties, Map<String,String> requestInfoProperties) Factory method to create a create request from the given set of property maps.
static Map<String,Map<String,PropertyInfo>>	getJMXPropertyIds(Resource.Type resourceType)
static Map<Resource.Type,String>	getKeyPropertyIds(Resource.Type resourceType)
static Map<String,Map<String,PropertyInfo>>	getMetricPropertyIds(Resource.Type resourceType)
static Map<String,Object>	getProperties(Resource resource) Get a map of all the property values keyed by property id for the given resource.
static String	getPropertyCategory(String property) Gets the parent category from a given property string.
static String	getPropertyId(String category, String name)
static Set<String>	getPropertyIds(Map<String,Map<String,PropertyInfo>> componentPropertyInfoMap) Extract the set of property ids from a component PropertyInfo map.
static Set<String>	getPropertyIds(Resource.Type resourceType)
static String	getPropertyName(String absProperty) Helper to get a property name from a string.
static Request	getReadRequest(Set<String> propertyIds) Factory method to create a read request from the given set of property ids.
static Request	getReadRequest(Set<String> propertyIds, Map<String,String> requestInfoProperties, Map<String,TemporalInfo> mapTemporalInfo, PageRequest pageRequest, SortRequest sortRequest) Factory method to create a read request from the given set of property ids.
static Request	getReadRequest(Set<String> propertyIds, Map<String,TemporalInfo> mapTemporalInfo) Factory method to create a read request from the given set of property ids.
static Request	getReadRequest(String... propertyIds) Factory method to create a read request from the given set of property ids.
static Map<String,Map<String,PropertyInfo>>	getSQLServerPropertyIds(Resource.Type resourceType)
static Request	getUpdateRequest(Map<String,Object> properties, Map<String,String> requestInfoProperties) Factory method to create an update request from the given map of properties.
static boolean	hasAggregateFunctionSuffix(String propertyId) Check if property ends with a trailing suffix of function id.
static Map<String,Metric>	processRpcMetricDefinition(String metricType, String componentName, String propertyId, Metric metric) Special handle rpc port tags added to metric names for HDFS Namenode Returns the replacement definitions
static void	setKeyPropertyIds(Resource.Type resourceType, Map<Resource.Type,String> keyPropertyKeys)
static void	setPropertyIds(Resource.Type resourceType, Set<String> propertyIds)
static void	updateMetricsWithAggregateFunctionSupport(Map<String,Map<String,PropertyInfo>> metrics) This method adds supported propertyInfo for component metrics with aggregate function ids.

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_PATH_SEP

public static final char EXTERNAL_PATH_SEP

See Also:

Constant Field Values

AGGREGATE_FUNCTION_IDENTIFIERS

public static final List<String> AGGREGATE_FUNCTION_IDENTIFIERS

Aggregate functions implicitly supported by the Metrics Service

Constructor Detail

PropertyHelper

public PropertyHelper()

Method Detail

getPropertyId

public static String getPropertyId(String category,
                                   String name)

getPropertyIds

public static Set<String> getPropertyIds(Resource.Type resourceType)

setPropertyIds

public static void setPropertyIds(Resource.Type resourceType,
                                  Set<String> propertyIds)

getPropertyIds

public static Set<String> getPropertyIds(Map<String,Map<String,PropertyInfo>> componentPropertyInfoMap)

Extract the set of property ids from a component PropertyInfo map.

Parameters:

componentPropertyInfoMap - the map

Returns:

the set of property ids

getMetricPropertyIds

public static Map<String,Map<String,PropertyInfo>> getMetricPropertyIds(Resource.Type resourceType)

getSQLServerPropertyIds

public static Map<String,Map<String,PropertyInfo>> getSQLServerPropertyIds(Resource.Type resourceType)

getJMXPropertyIds

public static Map<String,Map<String,PropertyInfo>> getJMXPropertyIds(Resource.Type resourceType)

getKeyPropertyIds

public static Map<Resource.Type,String> getKeyPropertyIds(Resource.Type resourceType)

setKeyPropertyIds

public static void setKeyPropertyIds(Resource.Type resourceType,
                                     Map<Resource.Type,String> keyPropertyKeys)

getPropertyName

public static String getPropertyName(String absProperty)

Helper to get a property name from a string.

Parameters:

absProperty - the fully qualified property

Returns:

the property name

getPropertyCategory

public static String getPropertyCategory(String property)

Gets the parent category from a given property string. This method is used in many places by many different consumers. In general, it will check to see if the property contains arguments. If not, then a simple String.substring(int, int) is used along with EXTERNAL_PATH_SEP.

In the event that a property contains a $d parameter, it will attempt to strip out any embedded methods in the various tokens. For example, if a property of foo/$1.substring(5)/bar/$2.substring(1)/baz is given, the expected recursive categories would be:

• foo
• foo/$1
• foo/$1/bar
• foo/$1/bar
• foo/$1/bar/$2

foo/$1.substring(5)/bar is incorrect as a category.

Parameters:

property - the fully qualified property

Returns:

the property category; null if there is no category

getCategories

public static Set<String> getCategories(Set<String> propertyIds)

Get the set of categories for the given property ids.

Parameters:

propertyIds - the property ids

Returns:

the set of categories

containsProperty

public static boolean containsProperty(Set<String> propertyIds,
                                       String propertyId)

Check if the given property id or one of its parent category ids is contained in the given set of property ids.

Parameters:

propertyIds - the set of property ids

propertyId - the property id

Returns:

true if the given property id of one of its parent category ids is contained in the given set of property ids

containsArguments

public static boolean containsArguments(String propertyId)

Check to see if the given property id contains replacement arguments (e.g. $1)

Parameters:

propertyId - the property id to check

Returns:

true if the given property id contains any replacement arguments

getAssociatedPropertyIds

public static Set<String> getAssociatedPropertyIds(Request request)

Get all of the property ids associated with the given request.

Parameters:

request - the request

Returns:

the associated properties

getProperties

public static Map<String,Object> getProperties(Resource resource)

Get a map of all the property values keyed by property id for the given resource.

Parameters:

resource - the resource

Returns:

the map of properties for the given resource

getCreateRequest

public static Request getCreateRequest(Set<Map<String,Object>> properties,
                                       Map<String,String> requestInfoProperties)

Factory method to create a create request from the given set of property maps. Each map contains the properties to be used to create a resource. Multiple maps in the set should result in multiple creates.

Parameters:

properties - resource properties associated with the request; may be null

requestInfoProperties - request specific properties; may be null

getReadRequest

public static Request getReadRequest(Set<String> propertyIds)

Factory method to create a read request from the given set of property ids. The set of property ids represents the properties of interest for the query.

Parameters:

propertyIds - the property ids associated with the request; may be null

getReadRequest

public static Request getReadRequest(Set<String> propertyIds,
                                     Map<String,TemporalInfo> mapTemporalInfo)

Factory method to create a read request from the given set of property ids. The set of property ids represents the properties of interest for the query.

Parameters:

propertyIds - the property ids associated with the request; may be null

mapTemporalInfo - the temporal info

getReadRequest

public static Request getReadRequest(Set<String> propertyIds,
                                     Map<String,String> requestInfoProperties,
                                     Map<String,TemporalInfo> mapTemporalInfo,
                                     PageRequest pageRequest,
                                     SortRequest sortRequest)

Factory method to create a read request from the given set of property ids. The set of property ids represents the properties of interest for the query.

Parameters:

propertyIds - the property ids associated with the request; may be null

requestInfoProperties - request info properties

mapTemporalInfo - the temporal info

pageRequest - an optional page request, or null for none.

sortRequest - an optional sort request, or null for none.

getReadRequest

public static Request getReadRequest(String... propertyIds)

Factory method to create a read request from the given set of property ids. The set of property ids represents the properties of interest for the query.

Parameters:

propertyIds - the property ids associated with the request; may be null

getUpdateRequest

public static Request getUpdateRequest(Map<String,Object> properties,
                                       Map<String,String> requestInfoProperties)

Factory method to create an update request from the given map of properties. The properties values in the given map are used to update the resource.

Parameters:

properties - resource properties associated with the request; may be null

requestInfoProperties - request specific properties; may be null

updateMetricsWithAggregateFunctionSupport

public static void updateMetricsWithAggregateFunctionSupport(Map<String,Map<String,PropertyInfo>> metrics)

This method adds supported propertyInfo for component metrics with aggregate function ids. API calls with multiple aggregate functions applied to a single metric need this support. Currently this support is added only for Component & Report metrics. This can be easily extended by making the call from the appropriate sub class of: @AMSPropertyProvider.

hasAggregateFunctionSuffix

public static boolean hasAggregateFunctionSuffix(String propertyId)

Check if property ends with a trailing suffix of function id.

processRpcMetricDefinition

public static Map<String,Metric> processRpcMetricDefinition(String metricType,
                                                            String componentName,
                                                            String propertyId,
                                                            Metric metric)

Special handle rpc port tags added to metric names for HDFS Namenode Returns the replacement definitions