org.apache.ambari.server.controller.spi

Interface ClusterController

All Superinterfaces:

SchemaFactory

All Known Implementing Classes:

ClusterControllerImpl

public interface ClusterController
extends SchemaFactory

The cluster controller is the main access point for accessing resources from the backend sources. A cluster controller maintains a mapping of resource providers keyed by resource types.

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResources(Resource.Type type, Request request) Create the resources defined by the properties in the given request object.
RequestStatus	deleteResources(Resource.Type type, Request request, Predicate predicate) Delete the resources selected by the given predicate.
ResourceProvider	ensureResourceProvider(Resource.Type type) Get the resource provider for the given type, creating it if required.
Predicate	getAmendedPredicate(Resource.Type type, Predicate predicate) Gets the amended predicate for a resource.
Iterable<Resource>	getIterable(Resource.Type type, QueryResponse queryResponse, Request request, Predicate predicate, PageRequest pageRequest, SortRequest sortRequest) Get an iterable set of resources from the given set of resources filtered by the given request and predicate objects.
PageResponse	getPage(Resource.Type type, QueryResponse queryResponse, Request request, Predicate predicate, PageRequest pageRequest, SortRequest sortRequest) Get a page of resources from the given set filtered by the given request, predicate objects and page request.
QueryResponse	getResources(Resource.Type type, Request request, Predicate predicate) Get the resources of the given type filtered by the given request and predicate objects.
Schema	getSchema(Resource.Type type) Get the schema for the given resource type.
Set<Resource>	populateResources(Resource.Type type, Set<Resource> resources, Request request, Predicate predicate) Populate the given resources from the associated property providers.
RequestStatus	updateResources(Resource.Type type, Request request, Predicate predicate) Update the resources selected by the given predicate with the properties from the given request object.

Method Detail

getResources

QueryResponse getResources(Resource.Type type,
                           Request request,
                           Predicate predicate)
                    throws UnsupportedPropertyException,
                           NoSuchResourceException,
                           NoSuchParentResourceException,
                           SystemException

Get the resources of the given type filtered by the given request and predicate objects.

Parameters:

type - the type of the requested resources

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

predicate - the predicate object which filters which resources are returned

Returns:

the query response

Throws:

UnsupportedPropertyException - thrown if the request or predicate contain unsupported property ids

SystemException - an internal exception occurred

NoSuchResourceException - no matching resource(s) found

NoSuchParentResourceException - a specified parent resource doesn't exist

populateResources

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

Populate the given resources from the associated property providers. This method may filter the resources based on the predicate and return a subset of the given resources.

Parameters:

type - the resource type

resources - the resources to be populated

request - the request

predicate - the predicate

Returns:

the set of resources that were successfully populated

Throws:

SystemException - if unable to populate the resources

getIterable

Iterable<Resource> getIterable(Resource.Type type,
                               QueryResponse queryResponse,
                               Request request,
                               Predicate predicate,
                               PageRequest pageRequest,
                               SortRequest sortRequest)
                        throws NoSuchParentResourceException,
                               UnsupportedPropertyException,
                               NoSuchResourceException,
                               SystemException

Get an iterable set of resources from the given set of resources filtered by the given request and predicate objects.

Parameters:

type - type of resources

queryResponse - the response from the resource query

request - the request

predicate - the predicate object which filters which resources are returned

pageRequest - the page request for a paginated response

sortRequest - the sortRequest object which defines if the resources need to be sorted

Returns:

a page response representing the requested page of resources

Throws:

UnsupportedPropertyException - thrown if the request or predicate contain unsupported property ids

SystemException - an internal exception occurred

NoSuchResourceException - no matching resource(s) found

NoSuchParentResourceException - a specified parent resource doesn't exist

getPage

PageResponse getPage(Resource.Type type,
                     QueryResponse queryResponse,
                     Request request,
                     Predicate predicate,
                     PageRequest pageRequest,
                     SortRequest sortRequest)
              throws UnsupportedPropertyException,
                     SystemException,
                     NoSuchResourceException,
                     NoSuchParentResourceException

Get a page of resources from the given set filtered by the given request, predicate objects and page request.

Parameters:

type - type of resources

queryResponse - the response from the resource query

request - the request

predicate - the predicate object which filters which resources are returned

pageRequest - the page request for a paginated response

Returns:

a page response representing the requested page of resources

Throws:

UnsupportedPropertyException - thrown if the request or predicate contain unsupported property ids

SystemException - an internal exception occurred

NoSuchResourceException - no matching resource(s) found

NoSuchParentResourceException - a specified parent resource doesn't exist

getSchema

Schema getSchema(Resource.Type type)

Get the schema for the given resource type. The schema for a given resource type describes the properties and categories provided by that type of resource.

Specified by:

getSchema in interface SchemaFactory

Parameters:

type - the resource type

Returns:

the schema object for the given resource

ensureResourceProvider

ResourceProvider ensureResourceProvider(Resource.Type type)

Get the resource provider for the given type, creating it if required.

Parameters:

type - the resource type

Returns:

the resource provider

createResources

RequestStatus createResources(Resource.Type type,
                              Request request)
                       throws UnsupportedPropertyException,
                              SystemException,
                              ResourceAlreadyExistsException,
                              NoSuchParentResourceException

Create the resources defined by the properties in the given request object.

Parameters:

type - the type of the resources

request - the request object which defines the set of properties for the resources to be created

Throws:

UnsupportedPropertyException - thrown if the request contains unsupported property ids

SystemException - an internal exception occurred

ResourceAlreadyExistsException - attempted to create a resource that already exists

NoSuchParentResourceException - a specified parent resource doesn't exist

updateResources

RequestStatus updateResources(Resource.Type type,
                              Request request,
                              Predicate predicate)
                       throws UnsupportedPropertyException,
                              SystemException,
                              NoSuchResourceException,
                              NoSuchParentResourceException

Update the resources selected by the given predicate with the properties from the given request object.

Parameters:

type - the type of the resources

request - the request object which defines the set of properties for the resources to be updated

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

Throws:

UnsupportedPropertyException - thrown if the request or predicate contain unsupported property ids

SystemException - an internal exception occurred

NoSuchResourceException - no matching resource(s) found

NoSuchParentResourceException - a specified parent resource doesn't exist

deleteResources

RequestStatus deleteResources(Resource.Type type,
                              Request request,
                              Predicate predicate)
                       throws UnsupportedPropertyException,
                              SystemException,
                              NoSuchResourceException,
                              NoSuchParentResourceException

Delete the resources selected by the given predicate.

Parameters:

type - the type of the resources

request - the request object which defines the set of properties for the resources to be deleted

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

Throws:

UnsupportedPropertyException - thrown if the predicate contains unsupported property ids

SystemException - an internal exception occurred

NoSuchResourceException - no matching resource(s) found

NoSuchParentResourceException - a specified parent resource doesn't exist

getAmendedPredicate

Predicate getAmendedPredicate(Resource.Type type,
                              Predicate predicate)

Gets the amended predicate for a resource.

Parameters:

type - the type of the resource

predicate - the predicate object to use for filtering

Returns:

the new predicate used for filtering