org.apache.ambari.server.controller.spi

Interface ExtendedResourceProvider

All Superinterfaces:

ResourceProvider

All Known Implementing Classes:

AlertHistoryResourceProvider, AlertNoticeResourceProvider, AlertResourceProvider, StageResourceProvider

public interface ExtendedResourceProvider
extends ResourceProvider

Extended resource provider interface that adds the ability to return a QueryResponse from a resource query. If a resource provider supports paging and/or sorting of the resources acquired through a query then it should implement ExtendedResourceProvider.

Method Summary

Modifier and Type	Method and Description
QueryResponse	queryForResources(Request request, Predicate predicate) Query for resources that match the given predicate.

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

checkPropertyIds, createResources, deleteResources, getKeyPropertyIds, getResources, updateResources

Method Detail

queryForResources

QueryResponse queryForResources(Request request,
                                Predicate predicate)
                         throws SystemException,
                                UnsupportedPropertyException,
                                NoSuchResourceException,
                                NoSuchParentResourceException

Query for resources that match the given predicate.

Parameters:

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

predicate - the predicate object which can be used to filter which resources are returned

Returns:

the response from the resource query

Throws:

SystemException - an internal system exception occurred

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the requested resource instance doesn't exist

NoSuchParentResourceException - a parent resource of the requested resource doesn't exist