org.apache.ambari.server.controller.internal

Class AbstractResourceProvider

java.lang.Object

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

org.apache.ambari.server.controller.internal.AbstractResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

Direct Known Subclasses:

AbstractAuthorizedResourceProvider, AbstractDRResourceProvider, AbstractJDBCResourceProvider, ArtifactResourceProvider, PermissionResourceProvider, StackDependencyResourceProvider, ViewExternalSubResourceProvider, ViewPermissionResourceProvider, ViewSubResourceProvider, ViewVersionResourceProvider

public abstract class AbstractResourceProvider
extends BaseProvider
implements ResourceProvider, ObservableResourceProvider

Abstract resource provider implementation that maps to an Ambari management controller.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractResourceProvider.Command<T> Command to invoke against the Ambari backend.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Resource.Type,String>	keyPropertyIds Key property mapping by resource type.
protected static org.slf4j.Logger	LOG
protected static String	PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceProvider(Set<String> propertyIds, Map<Resource.Type,String> keyPropertyIds) Create a new resource provider.

Method Summary

Modifier and Type	Method and Description
void	addObserver(ResourceProviderObserver observer) Add an observer.
protected <T> T	createResources(AbstractResourceProvider.Command<T> command) Invoke a command against the Ambari backend to create resources and map any AmbariException to the types appropriate for the ResourceProvider interface.
static List<ConfigurationRequest>	getConfigurationRequests(String parentCategory, Map<String,Object> properties) Helper method to get a configuration request, if one exists.
Map<Resource.Type,String>	getKeyPropertyIds() Get the key property ids for the resource type associated with this resource provider.
protected abstract Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
protected Set<Map<String,Object>>	getPropertyMaps(Map<String,Object> requestPropertyMap, Predicate givenPredicate) Get a set of properties from the given property map and predicate.
protected Set<Map<String,Object>>	getPropertyMaps(Predicate givenPredicate) Get a set of properties from the given predicate.
protected static Object	getQueryParameterValue(String queryParameterId, Predicate predicate) Extracting given query_parameter value from the predicate
protected RequestStatus	getRequestStatus(RequestStatusResponse response) Get a request status
protected RequestStatus	getRequestStatus(RequestStatusResponse response, Set<Resource> associatedResources) Get a request status
protected RequestStatus	getRequestStatus(RequestStatusResponse response, Set<Resource> associatedResources, RequestStatusMetaData requestStatusMetaData)
protected <T> T	getResources(AbstractResourceProvider.Command<T> command) Invoke a command against the Ambari backend to get resources and map any AmbariException to the types appropriate for the ResourceProvider interface.
protected <T> T	modifyResources(AbstractResourceProvider.Command<T> command) Invoke a command against the Ambari backend to modify resources and map any AmbariException to the types appropriate for the ResourceProvider interface.
protected void	notifyCreate(Resource.Type type, Request request) Notify all listeners of a creation event.
protected void	notifyDelete(Resource.Type type, Predicate predicate) Notify all listeners of a delete event.
protected void	notifyUpdate(Resource.Type type, Request request, Predicate predicate) Notify all listeners of a update event.
static void	parseProperties(ConfigurationRequest config, String absCategory, String propName, String propValue)
void	updateObservers(ResourceProviderEvent event) Update all registered observers with the given event.

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.ResourceProvider

checkPropertyIds, createResources, deleteResources, getResources, updateResources

Field Detail

keyPropertyIds

protected final Map<Resource.Type,String> keyPropertyIds

Key property mapping by resource type.

LOG

protected static final org.slf4j.Logger LOG

PROPERTIES_ATTRIBUTES_REGEX

protected static final String PROPERTIES_ATTRIBUTES_REGEX

See Also:

Constant Field Values

Constructor Detail

AbstractResourceProvider

protected AbstractResourceProvider(Set<String> propertyIds,
                                   Map<Resource.Type,String> keyPropertyIds)

Create a new resource provider.

Parameters:

propertyIds - the property ids

keyPropertyIds - the key property ids

Method Detail

getKeyPropertyIds

public Map<Resource.Type,String> getKeyPropertyIds()

Description copied from interface: ResourceProvider

Get the key property ids for the resource type associated with this resource provider. The key properties are those that uniquely identify the resource.

For example, the resource 'HostComponent' is uniquely identified by its associated 'Cluster', 'Host' and 'Component' resources. The key property ids for a 'HostComponent' resource includes the property ids of the foreign key references from the 'HostComponent' to 'Cluster', 'Host' and 'Component' resources.

Specified by:

getKeyPropertyIds in interface ResourceProvider

Returns:

a map of key property ids

updateObservers

public void updateObservers(ResourceProviderEvent event)

Description copied from interface: ObservableResourceProvider

Update all registered observers with the given event.

Specified by:

updateObservers in interface ObservableResourceProvider

Parameters:

event - the event

addObserver

public void addObserver(ResourceProviderObserver observer)

Description copied from interface: ObservableResourceProvider

Add an observer.

Specified by:

addObserver in interface ObservableResourceProvider

Parameters:

observer - the observer

getPKPropertyIds

protected abstract Set<String> getPKPropertyIds()

Get the set of property ids that uniquely identify the resources of this provider.

Returns:

the set of primary key properties

notifyCreate

protected void notifyCreate(Resource.Type type,
                            Request request)

Notify all listeners of a creation event.

Parameters:

type - the type of the resources being created

request - the request used to create the resources

notifyUpdate

protected void notifyUpdate(Resource.Type type,
                            Request request,
                            Predicate predicate)

Notify all listeners of a update event.

Parameters:

type - the type of the resources being updated

request - the request used to update the resources

predicate - the predicate used to update the resources

notifyDelete

protected void notifyDelete(Resource.Type type,
                            Predicate predicate)

Notify all listeners of a delete event.

Parameters:

type - the type of the resources being deleted

predicate - the predicate used to delete the resources

getPropertyMaps

protected Set<Map<String,Object>> getPropertyMaps(Predicate givenPredicate)

Get a set of properties from the given predicate. The returned set of property/value mappings is required to generate delete or get requests to the back end which does not deal with predicates. Note that the single predicate can result in multiple backend requests.

Parameters:

givenPredicate - the predicate

Returns:

the set of properties used to build request objects

getPropertyMaps

protected Set<Map<String,Object>> getPropertyMaps(Map<String,Object> requestPropertyMap,
                                                  Predicate givenPredicate)
                                           throws UnsupportedPropertyException,
                                                  SystemException,
                                                  NoSuchResourceException,
                                                  NoSuchParentResourceException

Get a set of properties from the given property map and predicate. The returned set of property/value mappings is required to generate update requests to the back end which does not deal with Predicates. Note that the single property map & predicate can result in multiple backend requests.

Parameters:

requestPropertyMap - the request update properties; may not be null

givenPredicate - the predicate

Returns:

the set of properties used to build request objects

Throws:

UnsupportedPropertyException

SystemException

NoSuchResourceException

NoSuchParentResourceException

getRequestStatus

protected RequestStatus getRequestStatus(RequestStatusResponse response,
                                         Set<Resource> associatedResources)

Get a request status

Returns:

the request status

getRequestStatus

protected RequestStatus getRequestStatus(RequestStatusResponse response,
                                         Set<Resource> associatedResources,
                                         RequestStatusMetaData requestStatusMetaData)

getRequestStatus

protected RequestStatus getRequestStatus(RequestStatusResponse response)

Get a request status

Returns:

the request status

getQueryParameterValue

protected static Object getQueryParameterValue(String queryParameterId,
                                               Predicate predicate)

Extracting given query_parameter value from the predicate

Parameters:

queryParameterId - query parameter id

predicate - predicate

Returns:

the query parameter

createResources

protected <T> T createResources(AbstractResourceProvider.Command<T> command)
                         throws SystemException,
                                ResourceAlreadyExistsException,
                                NoSuchParentResourceException

Invoke a command against the Ambari backend to create resources and map any AmbariException to the types appropriate for the ResourceProvider interface.

Type Parameters:

T - the type of the response

Parameters:

command - the command to invoke

Returns:

the response

Throws:

SystemException - thrown if a system exception occurred

ResourceAlreadyExistsException - thrown if a resource already exists

NoSuchParentResourceException - thrown if a parent of a resource doesn't exist

getResources

protected <T> T getResources(AbstractResourceProvider.Command<T> command)
                      throws SystemException,
                             NoSuchResourceException,
                             NoSuchParentResourceException

Invoke a command against the Ambari backend to get resources and map any AmbariException to the types appropriate for the ResourceProvider interface.

Type Parameters:

T - the type of the response

Parameters:

command - the command to invoke

Returns:

the response

Throws:

SystemException - thrown if a system exception occurred

NoSuchParentResourceException - thrown if a parent of a resource doesn't exist

NoSuchResourceException

modifyResources

protected <T> T modifyResources(AbstractResourceProvider.Command<T> command)
                         throws SystemException,
                                NoSuchResourceException,
                                NoSuchParentResourceException

Invoke a command against the Ambari backend to modify resources and map any AmbariException to the types appropriate for the ResourceProvider interface.

Type Parameters:

T - the type of the response

Parameters:

command - the command to invoke

Returns:

the response

Throws:

SystemException - thrown if a system exception occurred

NoSuchParentResourceException - thrown if a parent of a resource doesn't exist

NoSuchResourceException

getConfigurationRequests

public static List<ConfigurationRequest> getConfigurationRequests(String parentCategory,
                                                                  Map<String,Object> properties)

Helper method to get a configuration request, if one exists.

Parameters:

parentCategory - the parent category name. Checks for a property whose category is the parent and marked as a desired config.

properties - the properties on the request.

parseProperties

public static void parseProperties(ConfigurationRequest config,
                                   String absCategory,
                                   String propName,
                                   String propValue)