org.apache.ambari.server.controller.internal

Class BaseProvider

java.lang.Object

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

Direct Known Subclasses:

AbstractPropertyProvider, AbstractResourceProvider, AlertSummaryPropertyProvider, HttpPropertyProvider, JDBCResourceProvider, RootServiceComponentPropertyProvider

public abstract class BaseProvider
extends Object

Base provider implementation for both property and resource providers.

Constructor Summary

Constructors

Constructor and Description
BaseProvider(Set<String> propertyIds) Construct a provider.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkCategory(String unsupportedPropertyId) Check the categories to account for map properties where the entries will not be in the provider property list ids but the map (category) might be.
protected Set<String>	checkConfigPropertyIds(Set<String> base, String configCategory) Checks for property ids that are not recognized by the provider.
Set<String>	checkPropertyIds(Set<String> propertyIds)
protected boolean	containsArguments(String propertyId) Check to see if the given property id contains replacement arguments (e.g.
Set<String>	getCategoryIds() Get supported categories
Set<String>	getPropertyIds() Get the property ids supported by this property adapter.
protected Map.Entry<String,Pattern>	getRegexEntry(String id) Gets the key/value mapping between a metric string in the JSON files and the Java regular expression pattern that matches it.
protected List<String>	getRegexGroups(String regExpKey, String id) Extracts set of matcher.group() from id
protected Set<String>	getRequestPropertyIds(Request request, Predicate predicate) Get the set of property ids required to satisfy the given request.
protected boolean	isPatternKey(String id)
protected static boolean	isPropertyCategoryRequested(String propertyId, Set<String> requestedIds) Determine whether or not any of the requested ids are a category for the given property.
protected static boolean	isPropertyEntryRequested(String propertyId, Set<String> requestedIds) Determine whether or not any of the requested ids are an entry for the given property, if the given property is a category.
protected static boolean	isPropertyRequested(String propertyId, Set<String> requestedIds) Determine whether or not the given property id is part the given set of requested ids.
protected static boolean	setResourceProperty(Resource resource, String propertyId, Object value, Set<String> requestedIds) Set a property value on the given resource for the given id and value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseProvider

public BaseProvider(Set<String> propertyIds)

Construct a provider.

Parameters:

propertyIds - the properties associated with this provider

Method Detail

checkConfigPropertyIds

protected Set<String> checkConfigPropertyIds(Set<String> base,
                                             String configCategory)

Checks for property ids that are not recognized by the provider.

Parameters:

base - the base set of properties

configCategory - the config category that would have a desired_config element.

Returns:

the set of properties that are NOT known to the provider

checkPropertyIds

public Set<String> checkPropertyIds(Set<String> propertyIds)

getRequestPropertyIds

protected Set<String> getRequestPropertyIds(Request request,
                                            Predicate predicate)

Get the set of property ids required to satisfy the given request.

Parameters:

request - the request

predicate - the predicate

Returns:

the set of property ids needed to satisfy the request

checkCategory

protected boolean checkCategory(String unsupportedPropertyId)

Check the categories to account for map properties where the entries will not be in the provider property list ids but the map (category) might be.

getRegexEntry

protected Map.Entry<String,Pattern> getRegexEntry(String id)

Gets the key/value mapping between a metric string in the JSON files and the Java regular expression pattern that matches it.

Parameters:

id -

Returns:

the entry, or null if none match the ID.

getRegexGroups

protected List<String> getRegexGroups(String regExpKey,
                                      String id)

Extracts set of matcher.group() from id

Parameters:

regExpKey -

id -

Returns:

extracted regex groups from id

isPatternKey

protected boolean isPatternKey(String id)

containsArguments

protected 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

isPropertyRequested

protected static boolean isPropertyRequested(String propertyId,
                                             Set<String> requestedIds)

Determine whether or not the given property id is part the given set of requested ids. This accounts for the cases where the given properties are actually property categories.

Parameters:

propertyId - the property id

requestedIds - the requested set of property ids

Returns:

true if the given property id is part of the given set of requested ids

setResourceProperty

protected static boolean setResourceProperty(Resource resource,
                                             String propertyId,
                                             Object value,
                                             Set<String> requestedIds)

Set a property value on the given resource for the given id and value. Make sure that the id is in the given set of requested ids.

Parameters:

resource - the resource

propertyId - the property id

value - the value to set

requestedIds - the requested set of property ids

isPropertyEntryRequested

protected static boolean isPropertyEntryRequested(String propertyId,
                                                  Set<String> requestedIds)

Determine whether or not any of the requested ids are an entry for the given property, if the given property is a category. For example, if the given property is 'category/subcategory' and the set of requested ids contains 'category/subcategory/property' then this method should return true.

Parameters:

propertyId - the property id

requestedIds - the requested set of property ids

Returns:

true if the given property is a category for any of the requested ids

isPropertyCategoryRequested

protected static boolean isPropertyCategoryRequested(String propertyId,
                                                     Set<String> requestedIds)

Determine whether or not any of the requested ids are a category for the given property. For example, if the given property is 'category/subcategory/property' and the set of requested ids contains 'category' or 'category/subcategory' then this method should return true.

Parameters:

propertyId - the property id

requestedIds - the requested set of property ids

Returns:

true if the given property's category is part of the given set of requested ids

getPropertyIds

public Set<String> getPropertyIds()

Get the property ids supported by this property adapter.

Returns:

the property ids supported by this provider

getCategoryIds

public Set<String> getCategoryIds()

Get supported categories