org.apache.ambari.server.controller.internal

Class AbstractPropertyProvider

java.lang.Object

org.apache.ambari.server.controller.internal.BaseProvider

org.apache.ambari.server.controller.internal.AbstractPropertyProvider

All Implemented Interfaces:

PropertyProvider

Direct Known Subclasses:

MetricsPropertyProvider, MetricsPropertyProviderProxy, MetricsReportPropertyProvider, MetricsReportPropertyProviderProxy, ThreadPoolEnabledPropertyProvider

public abstract class AbstractPropertyProvider
extends BaseProvider
implements PropertyProvider

Abstract property provider implementation.

Constructor Summary

Constructors

Constructor and Description
AbstractPropertyProvider(Map<String,Map<String,PropertyInfo>> componentMetrics) Construct a provider.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkAuthorizationForMetrics(Set<Resource> resources, String clusterNamePropertyId) Check the User's authorization for retrieving the Metrics.
protected boolean	checkPropertyCategory(String propertyId) Verify if the property category is supported
protected Set<String>	getClustersNameFromResources(Set<Resource> resources, String clusterNamePropertyId) Retrieves all the cluster names to which the passed-in Resource's belong.
protected Set<Long>	getClustersResourceId(Set<Resource> resources, String clusterNamePropertyId) Retrieves all the 'Cluster's Resource Ids' from the passed-in Resources.
Map<String,Map<String,PropertyInfo>>	getComponentMetrics() Get the map of metrics for this provider.
protected Map<String,PropertyInfo>	getPropertyInfoMap(String componentName, String propertyId) Get a map of metric / property info based on the given component name and property id.
protected String	getResourceTypeFromResources(Set<Resource> resources) Retrieves passed-in Resource's Type
protected static Object	getValue(org.apache.hadoop.metrics2.sink.timeline.TimelineMetric metric, TemporalInfo temporalInfo) Get value from the given metric.
protected boolean	isSupportedPropertyId(String componentName, String propertyId) Verify that the component metrics contains the property id.
protected static String	substituteArgument(String propertyId, String argName, String val) Substitute the given value into the argument in the given property id.
protected void	updateComponentMetricMap(Map<String,PropertyInfo> componentMetricMap, String propertyId) Adds to the componentMetricMap a specific(not regexp) metric for the propertyId
protected PropertyInfo	updatePropertyInfo(String propertyKey, String id, PropertyInfo propertyInfo)
protected void	updatePropertyInfoMap(String componentName, String propertyId, Map<String,PropertyInfo> propertyInfoMap)

Methods inherited from class org.apache.ambari.server.controller.internal.BaseProvider

checkCategory, checkConfigPropertyIds, checkPropertyIds, containsArguments, getCategoryIds, getPropertyIds, getRegexEntry, getRegexGroups, getRequestPropertyIds, isPatternKey, isPropertyCategoryRequested, isPropertyEntryRequested, isPropertyRequested, setResourceProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.controller.spi.PropertyProvider

checkPropertyIds, populateResources

Constructor Detail

AbstractPropertyProvider

public AbstractPropertyProvider(Map<String,Map<String,PropertyInfo>> componentMetrics)

Construct a provider.

Parameters:

componentMetrics - map of metrics for this provider

Method Detail

getComponentMetrics

public Map<String,Map<String,PropertyInfo>> getComponentMetrics()

Get the map of metrics for this provider.

Returns:

the map of metric / property info.

getResourceTypeFromResources

protected String getResourceTypeFromResources(Set<Resource> resources)

Retrieves passed-in Resource's Type

Parameters:

resources - Set of Resources.

Returns:

Type of resource from the Set.

getClustersNameFromResources

protected Set<String> getClustersNameFromResources(Set<Resource> resources,
                                                   String clusterNamePropertyId)

Retrieves all the cluster names to which the passed-in Resource's belong.

Parameters:

resources - Set of Resources.

Returns:

Cluster's Name

getClustersResourceId

protected Set<Long> getClustersResourceId(Set<Resource> resources,
                                          String clusterNamePropertyId)

Retrieves all the 'Cluster's Resource Ids' from the passed-in Resources.

Parameters:

resources - Set of Resources.

clusterNamePropertyId - ClusterName PropertyId.

Returns:

cluster Id.

checkAuthorizationForMetrics

protected boolean checkAuthorizationForMetrics(Set<Resource> resources,
                                               String clusterNamePropertyId)
                                        throws AuthorizationException

Check the User's authorization for retrieving the Metrics.

Parameters:

resources - Set of Resources.

clusterNamePropertyId - ClusterName PropertyId.

Returns:

boolean

Throws:

AuthorizationException

getPropertyInfoMap

protected Map<String,PropertyInfo> getPropertyInfoMap(String componentName,
                                                      String propertyId)

Get a map of metric / property info based on the given component name and property id. Note that the property id may map to multiple metrics if the property id is a category.

Parameters:

componentName - the component name

propertyId - the property id; may be a category

Returns:

a map of metrics

updatePropertyInfoMap

protected void updatePropertyInfoMap(String componentName,
                                     String propertyId,
                                     Map<String,PropertyInfo> propertyInfoMap)

substituteArgument

protected static String substituteArgument(String propertyId,
                                           String argName,
                                           String val)

Substitute the given value into the argument in the given property id. If there are methods attached to the argument then execute them for the given value.

Parameters:

propertyId - the property id

argName - the argument name

val - the value to substitute

Returns:

the modified property id

updateComponentMetricMap

protected void updateComponentMetricMap(Map<String,PropertyInfo> componentMetricMap,
                                        String propertyId)

Adds to the componentMetricMap a specific(not regexp) metric for the propertyId

Parameters:

componentMetricMap -

propertyId -

updatePropertyInfo

protected PropertyInfo updatePropertyInfo(String propertyKey,
                                          String id,
                                          PropertyInfo propertyInfo)

isSupportedPropertyId

protected boolean isSupportedPropertyId(String componentName,
                                        String propertyId)

Verify that the component metrics contains the property id.

Parameters:

componentName - Name of the component

propertyId - Property Id

Returns:

true/false

checkPropertyCategory

protected boolean checkPropertyCategory(String propertyId)

Verify if the property category is supported

getValue

protected static Object getValue(org.apache.hadoop.metrics2.sink.timeline.TimelineMetric metric,
                                 TemporalInfo temporalInfo)

Get value from the given metric.

Parameters:

metric - the metric

temporalInfo - indicates whether or not this a temporal metric

Returns:

a range of temporal data or a point in time value if not temporal