org.apache.ambari.server.controller.spi

Interface PropertyProvider

All Known Implementing Classes:

AbstractPropertyProvider, AlertSummaryPropertyProvider, AMSComponentPropertyProvider, AMSHostComponentPropertyProvider, AMSHostPropertyProvider, AMSPropertyProvider, AMSReportPropertyProvider, GangliaComponentPropertyProvider, GangliaHostComponentPropertyProvider, GangliaHostPropertyProvider, GangliaPropertyProvider, GangliaReportPropertyProvider, HttpPropertyProvider, JMXPropertyProvider, LoggingSearchPropertyProvider, MetricsPropertyProvider, MetricsPropertyProviderProxy, MetricsReportPropertyProvider, MetricsReportPropertyProviderProxy, RestMetricsPropertyProvider, RootServiceComponentPropertyProvider, StackDefinedPropertyProvider, ThreadPoolEnabledPropertyProvider

public interface PropertyProvider

The property provider is used to plug in various property sources into a resource provider. The property provider is able to populate, or partially populate a given resource object with property values.

Method Summary

Modifier and Type	Method and Description
Set<String>	checkPropertyIds(Set<String> propertyIds) Check whether the set of given property ids is supported by this resource provider.
Set<Resource>	populateResources(Set<Resource> resources, Request request, Predicate predicate) Populate the given set of resource with any properties that this property provider can provide and return a populated set of resources.

Method Detail

populateResources

Set<Resource> populateResources(Set<Resource> resources,
                                Request request,
                                Predicate predicate)
                         throws SystemException

Populate the given set of resource with any properties that this property provider can provide and return a populated set of resources. The provider may drop resources from the original set if it determines that the don't meet the conditions of the predicate.

Parameters:

resources - the resources to be populated

request - the request object which defines the desired set of properties

predicate - the predicate object which filters which resources are returned

Returns:

the populated set of resources

Throws:

SystemException - thrown if resources cannot be populated

checkPropertyIds

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

Check whether the set of given property ids is supported by this resource provider.

Returns:

a subset of the given property id set containing any property ids not supported by this resource provider. An empty return set indicates that all of the given property ids are supported.