org.apache.ambari.server.controller.internal

Class BlueprintResourceProvider

java.lang.Object

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

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

org.apache.ambari.server.controller.internal.AbstractAuthorizedResourceProvider

org.apache.ambari.server.controller.internal.AbstractControllerResourceProvider

org.apache.ambari.server.controller.internal.BlueprintResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class BlueprintResourceProvider
extends AbstractControllerResourceProvider

Resource Provider for Blueprint resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BlueprintResourceProvider.BlueprintConfigPopulationStrategy The structure of blueprints is evolving where multiple resource structures are to be supported.
protected static class	BlueprintResourceProvider.BlueprintConfigPopulationStrategyV1 Original blueprint configuration format where configs were a map of strings.
protected static class	BlueprintResourceProvider.BlueprintConfigPopulationStrategyV2 New blueprint configuration format where configs are a map from 'properties' and 'properties_attributes' to a map of strings.

Nested classes/interfaces inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

AbstractResourceProvider.Command<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLUEPRINT_NAME_PROPERTY_ID
static String	BLUEPRINT_SECURITY_PROPERTY_ID
static String	BLUEPRINTS_PROPERTY_ID
static String	COMPONENT_NAME_PROPERTY_ID
static String	COMPONENT_PROPERTY_ID
static String	COMPONENT_PROVISION_ACTION_PROPERTY_ID
static String	CONFIGURATION_LIST_CHECK_ERROR_MESSAGE
static String	CONFIGURATION_MAP_CHECK_ERROR_MESSAGE
static String	CONFIGURATION_MAP_SIZE_CHECK_ERROR_MESSAGE
static String	CONFIGURATION_PROPERTY_ID
static String	HOST_GROUP_CARDINALITY_PROPERTY_ID
static String	HOST_GROUP_NAME_PROPERTY_ID
static String	HOST_GROUP_PROPERTY_ID
static String	PROPERTIES_ATTRIBUTES_PROPERTY_ID
static String	PROPERTIES_PROPERTY_ID
static String	REQUEST_BODY_EMPTY_ERROR_MESSAGE
static String	SCHEMA_IS_NOT_SUPPORTED_MESSAGE
static String	SETTING_PROPERTY_ID
static String	STACK_NAME_PROPERTY_ID
static String	STACK_VERSION_PROPERTY_ID

Fields inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResources(Request request) Create the resources defined by the properties in the given request object.
RequestStatus	deleteResources(Request request, Predicate predicate) Delete the resources selected by the given predicate.
protected Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
Set<Resource>	getResources(Request request, Predicate predicate) Get a set of resources based on the given request and predicate information.
static void	init(BlueprintFactory factory, BlueprintDAO bpDao, TopologyRequestDAO trDao, SecurityConfigurationFactory securityFactory, com.google.gson.Gson gson, AmbariMetaInfo metaInfo) Static initialization.
static List<Map<String,Object>>	populateSettingList(Collection<? extends BlueprintSettingEntity> settings) Populate a list of setting property maps from a collection of setting entities.
protected Resource	toResource(BlueprintEntity entity, Set<String> requestedIds) Create a resource instance from a blueprint entity.
RequestStatus	updateResources(Request request, Predicate predicate) Update the resources selected by the given predicate with the properties from the given request object.

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractControllerResourceProvider

getClusterId, getClusterResourceId, getClusterResourceId, getManagementController, getResourceProvider, getResourceProvider, init

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractAuthorizedResourceProvider

createResourcesAuthorized, deleteResourcesAuthorized, getRequiredCreateAuthorizations, getRequiredDeleteAuthorizations, getRequiredGetAuthorizations, getRequiredUpdateAuthorizations, getResourceId, getResourcesAuthorized, getResourceType, isAuthorizedToCreateResources, isAuthorizedToDeleteResources, isAuthorizedToGetResources, isAuthorizedToUpdateResources, setRequiredCreateAuthorizations, setRequiredDeleteAuthorizations, setRequiredGetAuthorizations, setRequiredUpdateAuthorizations, updateResourcesAuthorized

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

addObserver, createResources, getConfigurationRequests, getKeyPropertyIds, getPropertyMaps, getPropertyMaps, getQueryParameterValue, getRequestStatus, getRequestStatus, getRequestStatus, getResources, modifyResources, notifyCreate, notifyDelete, notifyUpdate, parseProperties, updateObservers

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

Field Detail

BLUEPRINT_NAME_PROPERTY_ID

public static final String BLUEPRINT_NAME_PROPERTY_ID

STACK_NAME_PROPERTY_ID

public static final String STACK_NAME_PROPERTY_ID

STACK_VERSION_PROPERTY_ID

public static final String STACK_VERSION_PROPERTY_ID

BLUEPRINT_SECURITY_PROPERTY_ID

public static final String BLUEPRINT_SECURITY_PROPERTY_ID

BLUEPRINTS_PROPERTY_ID

public static final String BLUEPRINTS_PROPERTY_ID

See Also:

Constant Field Values

HOST_GROUP_PROPERTY_ID

public static final String HOST_GROUP_PROPERTY_ID

See Also:

Constant Field Values

HOST_GROUP_NAME_PROPERTY_ID

public static final String HOST_GROUP_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOST_GROUP_CARDINALITY_PROPERTY_ID

public static final String HOST_GROUP_CARDINALITY_PROPERTY_ID

See Also:

Constant Field Values

COMPONENT_PROPERTY_ID

public static final String COMPONENT_PROPERTY_ID

See Also:

Constant Field Values

COMPONENT_NAME_PROPERTY_ID

public static final String COMPONENT_NAME_PROPERTY_ID

See Also:

Constant Field Values

COMPONENT_PROVISION_ACTION_PROPERTY_ID

public static final String COMPONENT_PROVISION_ACTION_PROPERTY_ID

See Also:

Constant Field Values

CONFIGURATION_PROPERTY_ID

public static final String CONFIGURATION_PROPERTY_ID

See Also:

Constant Field Values

SETTING_PROPERTY_ID

public static final String SETTING_PROPERTY_ID

See Also:

Constant Field Values

PROPERTIES_PROPERTY_ID

public static final String PROPERTIES_PROPERTY_ID

See Also:

Constant Field Values

PROPERTIES_ATTRIBUTES_PROPERTY_ID

public static final String PROPERTIES_ATTRIBUTES_PROPERTY_ID

See Also:

Constant Field Values

SCHEMA_IS_NOT_SUPPORTED_MESSAGE

public static final String SCHEMA_IS_NOT_SUPPORTED_MESSAGE

See Also:

Constant Field Values

REQUEST_BODY_EMPTY_ERROR_MESSAGE

public static final String REQUEST_BODY_EMPTY_ERROR_MESSAGE

See Also:

Constant Field Values

CONFIGURATION_LIST_CHECK_ERROR_MESSAGE

public static final String CONFIGURATION_LIST_CHECK_ERROR_MESSAGE

See Also:

Constant Field Values

CONFIGURATION_MAP_CHECK_ERROR_MESSAGE

public static final String CONFIGURATION_MAP_CHECK_ERROR_MESSAGE

See Also:

Constant Field Values

CONFIGURATION_MAP_SIZE_CHECK_ERROR_MESSAGE

public static final String CONFIGURATION_MAP_SIZE_CHECK_ERROR_MESSAGE

See Also:

Constant Field Values

Method Detail

init

public static void init(BlueprintFactory factory,
                        BlueprintDAO bpDao,
                        TopologyRequestDAO trDao,
                        SecurityConfigurationFactory securityFactory,
                        com.google.gson.Gson gson,
                        AmbariMetaInfo metaInfo)

Static initialization.

Parameters:

factory - blueprint factory

bpDao - blueprint data access object

gson - json serializer

getPKPropertyIds

protected Set<String> getPKPropertyIds()

Description copied from class: AbstractResourceProvider

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

Specified by:

getPKPropertyIds in class AbstractResourceProvider

Returns:

the set of primary key properties

createResources

public RequestStatus createResources(Request request)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     ResourceAlreadyExistsException,
                                     NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

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

This implementation attempts to authorize the authenticated user before performing the requested operation. If authorization fails, an AuthorizationException will be thrown.

This method may be overwritten by implementing classes to avoid performing authorization checks to create resources.

Specified by:

createResources in interface ResourceProvider

Overrides:

createResources in class AbstractAuthorizedResourceProvider

Parameters:

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

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

ResourceAlreadyExistsException - attempted to create a resource which already exists

NoSuchParentResourceException - a parent resource of the resource to create doesn't exist

getResources

public Set<Resource> getResources(Request request,
                                  Predicate predicate)
                           throws SystemException,
                                  UnsupportedPropertyException,
                                  NoSuchResourceException,
                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Get a set of resources based on the given request and predicate information.

Note that it is not required for this resource provider to completely filter the set of resources based on the given predicate. It may not be possible since some of the properties involved may be provided by another provider. This partial filtering is allowed because the predicate will always be applied by the calling cluster controller. The predicate is made available at this level so that some pre-filtering can be done as an optimization.

A simple implementation of a resource provider may choose to just return all of the resources of a given type and allow the calling cluster controller to filter based on the predicate.

This implementation attempts to authorize the authenticated user before performing the requested operation. If authorization fails, an AuthorizationException will be thrown.

This method may be overwritten by implementing classes to avoid performing authorization checks to get resources.

Specified by:

getResources in interface ResourceProvider

Overrides:

getResources in class AbstractAuthorizedResourceProvider

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:

a set of resources based on the given request and predicate information

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

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

updateResources

public RequestStatus updateResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

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

This implementation attempts to authorize the authenticated user before performing the requested operation. If authorization fails, an AuthorizationException will be thrown.

This method may be overwritten by implementing classes to avoid performing authorization checks to update resources.

Specified by:

updateResources in interface ResourceProvider

Overrides:

updateResources in class AbstractAuthorizedResourceProvider

Parameters:

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

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the resource instance to be updated doesn't exist

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

deleteResources

public RequestStatus deleteResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Delete the resources selected by the given predicate.

This implementation attempts to authorize the authenticated user before performing the requested operation. If authorization fails, an AuthorizationException will be thrown.

This method may be overwritten by implementing classes to avoid performing authorization checks to delete resources.

Specified by:

deleteResources in interface ResourceProvider

Overrides:

deleteResources in class AbstractAuthorizedResourceProvider

Parameters:

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 deleted

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the resource instance to be deleted doesn't exist

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

toResource

protected Resource toResource(BlueprintEntity entity,
                              Set<String> requestedIds)
                       throws NoSuchResourceException

Create a resource instance from a blueprint entity.

Parameters:

entity - blueprint entity

requestedIds - requested id's

Returns:

a new resource instance for the given blueprint entity

Throws:

NoSuchResourceException

populateSettingList

public static List<Map<String,Object>> populateSettingList(Collection<? extends BlueprintSettingEntity> settings)
                                                    throws NoSuchResourceException

Populate a list of setting property maps from a collection of setting entities.

Parameters:

settings - collection of setting entities

Returns:

list of setting property maps

Throws:

NoSuchResourceException