org.apache.ambari.server.controller.internal

Class ClusterResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ClusterResourceProvider
extends AbstractControllerResourceProvider

Resource provider for cluster resources.

Nested Class Summary

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	ALL_PROPERTIES
static String	CLUSTER_CREDENTIAL_STORE_PROPERTIES_PROPERTY_ID
static String	CLUSTER_DESIRED_CONFIGS_PROPERTY_ID
static String	CLUSTER_DESIRED_SERVICE_CONFIG_VERSIONS_PROPERTY_ID
static String	CLUSTER_HEALTH_REPORT_PROPERTY_ID
static String	CLUSTER_ID
static String	CLUSTER_ID_PROPERTY_ID
static String	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY_ID
static String	CLUSTER_PROVISIONING_STATE_PROPERTY_ID
static String	CLUSTER_SECURITY_TYPE_PROPERTY_ID
static String	CLUSTER_STATE_PROPERTY_ID
static String	CLUSTER_TOTAL_HOSTS_PROPERTY_ID
static String	CLUSTER_VERSION_PROPERTY_ID
static String	CREDENTIAL_STORE_PROPERTIES
static String	CREDENTIALS
static String	DESIRED_CONFIGS
static String	DESIRED_SERVICE_CONFIG_VERSIONS
static String	GET_IGNORE_PERMISSIONS_PROPERTY_ID Request info property ID.
static String	HEALTH_REPORT
protected static Map<Resource.Type,String>	keyPropertyIds The key property ids for a cluster resource.
protected static Set<String>	propertyIds The property ids for a cluster resource.
static String	PROVISIONING_STATE
static String	REPO_VERSION
static String	RESPONSE_KEY
static String	SECURITY
static String	SECURITY_TYPE
static String	TOTAL_HOSTS
static String	VERSION

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

PROPERTIES_ATTRIBUTES_REGEX

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.
protected RequestStatus	createResourcesAuthorized(Request request) Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.
protected RequestStatus	deleteResourcesAuthorized(Request request, Predicate predicate) Delete the resources selected by the given predicate if the authenticated user is authorized to do so.
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.
protected static ServiceConfigVersionRequest	getServiceConfigVersionRequest(String parentCategory, Map<String,Object> properties) Helper method for creating rollback request
static void	init(TopologyManager manager, TopologyRequestFactory requestFactory, SecurityConfigurationFactory securityFactory, com.google.gson.Gson instance) Inject the blueprint data access object which is used to obtain blueprint entities.
protected boolean	isAuthorizedToCreateResources(org.springframework.security.core.Authentication authentication, Request request) Tests authorization to create resources.
protected boolean	isAuthorizedToDeleteResources(org.springframework.security.core.Authentication authentication, Predicate predicate) Tests authorization to delete resources.
protected RequestStatus	updateResourcesAuthorized(Request request, Predicate predicate) Update the resources selected by the given predicate with the properties from the given request object if the authenticated user is authorized to do so.

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

createResources, deleteResources, getRequiredCreateAuthorizations, getRequiredDeleteAuthorizations, getRequiredGetAuthorizations, getRequiredUpdateAuthorizations, getResourceId, getResourcesAuthorized, getResourceType, isAuthorizedToGetResources, isAuthorizedToUpdateResources, setRequiredCreateAuthorizations, setRequiredDeleteAuthorizations, setRequiredGetAuthorizations, setRequiredUpdateAuthorizations, updateResources

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, 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

Field Detail

RESPONSE_KEY

public static final String RESPONSE_KEY

See Also:

Constant Field Values

ALL_PROPERTIES

public static final String ALL_PROPERTIES

See Also:

Constant Field Values

CLUSTER_ID

public static final String CLUSTER_ID

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

PROVISIONING_STATE

public static final String PROVISIONING_STATE

See Also:

Constant Field Values

SECURITY_TYPE

public static final String SECURITY_TYPE

See Also:

Constant Field Values

DESIRED_CONFIGS

public static final String DESIRED_CONFIGS

See Also:

Constant Field Values

DESIRED_SERVICE_CONFIG_VERSIONS

public static final String DESIRED_SERVICE_CONFIG_VERSIONS

See Also:

Constant Field Values

TOTAL_HOSTS

public static final String TOTAL_HOSTS

See Also:

Constant Field Values

HEALTH_REPORT

public static final String HEALTH_REPORT

See Also:

Constant Field Values

CREDENTIAL_STORE_PROPERTIES

public static final String CREDENTIAL_STORE_PROPERTIES

See Also:

Constant Field Values

REPO_VERSION

public static final String REPO_VERSION

See Also:

Constant Field Values

CLUSTER_ID_PROPERTY_ID

public static final String CLUSTER_ID_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_VERSION_PROPERTY_ID

public static final String CLUSTER_VERSION_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_PROVISIONING_STATE_PROPERTY_ID

public static final String CLUSTER_PROVISIONING_STATE_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_SECURITY_TYPE_PROPERTY_ID

public static final String CLUSTER_SECURITY_TYPE_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_DESIRED_CONFIGS_PROPERTY_ID

public static final String CLUSTER_DESIRED_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_DESIRED_SERVICE_CONFIG_VERSIONS_PROPERTY_ID

public static final String CLUSTER_DESIRED_SERVICE_CONFIG_VERSIONS_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_TOTAL_HOSTS_PROPERTY_ID

public static final String CLUSTER_TOTAL_HOSTS_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_HEALTH_REPORT_PROPERTY_ID

public static final String CLUSTER_HEALTH_REPORT_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_CREDENTIAL_STORE_PROPERTIES_PROPERTY_ID

public static final String CLUSTER_CREDENTIAL_STORE_PROPERTIES_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_STATE_PROPERTY_ID

public static final String CLUSTER_STATE_PROPERTY_ID

SECURITY

public static final String SECURITY

See Also:

Constant Field Values

CREDENTIALS

public static final String CREDENTIALS

See Also:

Constant Field Values

GET_IGNORE_PERMISSIONS_PROPERTY_ID

public static final String GET_IGNORE_PERMISSIONS_PROPERTY_ID

Request info property ID. Allow internal getResources call to bypass permissions check.

See Also:

Constant Field Values

keyPropertyIds

protected static final Map<Resource.Type,String> keyPropertyIds

The key property ids for a cluster resource.

propertyIds

protected static final Set<String> propertyIds

The property ids for a cluster resource.

Method Detail

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

checkPropertyIds

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

Check whether the set of given property ids is supported by this resource provider. Overridden to support configuration.

Specified by:

checkPropertyIds in interface ResourceProvider

Overrides:

checkPropertyIds in class BaseProvider

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.

isAuthorizedToCreateResources

protected boolean isAuthorizedToCreateResources(org.springframework.security.core.Authentication authentication,
                                                Request request)

Description copied from class: AbstractAuthorizedResourceProvider

Tests authorization to create resources.

Implementations should override this method to perform a more sophisticated authorization routine.

Overrides:

isAuthorizedToCreateResources in class AbstractAuthorizedResourceProvider

Parameters:

authentication - the authenticated user and associated access privileges

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

Returns:

true if authorized; otherwise false

isAuthorizedToDeleteResources

protected boolean isAuthorizedToDeleteResources(org.springframework.security.core.Authentication authentication,
                                                Predicate predicate)
                                         throws SystemException

Description copied from class: AbstractAuthorizedResourceProvider

Tests authorization to delete resources.

Implementations should override this method to perform a more sophisticated authorization routine.

Overrides:

isAuthorizedToDeleteResources in class AbstractAuthorizedResourceProvider

Parameters:

authentication - the authenticated user and associated access privileges

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

Returns:

true if authorized; otherwise false

Throws:

SystemException - if an internal system exception occurred

createResourcesAuthorized

protected RequestStatus createResourcesAuthorized(Request request)
                                           throws SystemException,
                                                  UnsupportedPropertyException,
                                                  ResourceAlreadyExistsException,
                                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.

This method must be overwritten if AbstractAuthorizedResourceProvider.createResources(Request) is not overwritten.

Overrides:

createResourcesAuthorized 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

See Also:

AbstractAuthorizedResourceProvider.createResources(Request)

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

updateResourcesAuthorized

protected RequestStatus updateResourcesAuthorized(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 if the authenticated user is authorized to do so.

This method must be overwritten if AbstractAuthorizedResourceProvider.updateResources(Request, Predicate) is not overwritten.

Overrides:

updateResourcesAuthorized 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

See Also:

AbstractAuthorizedResourceProvider.updateResources(Request, Predicate)

deleteResourcesAuthorized

protected RequestStatus deleteResourcesAuthorized(Request request,
                                                  Predicate predicate)
                                           throws SystemException,
                                                  UnsupportedPropertyException,
                                                  NoSuchResourceException,
                                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Delete the resources selected by the given predicate if the authenticated user is authorized to do so.

This method must be overwritten if ResourceProvider.deleteResources(Request, Predicate) is not overwritten.

Overrides:

deleteResourcesAuthorized in class AbstractAuthorizedResourceProvider

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

See Also:

ResourceProvider.deleteResources(Request, Predicate)

init

public static void init(TopologyManager manager,
                        TopologyRequestFactory requestFactory,
                        SecurityConfigurationFactory securityFactory,
                        com.google.gson.Gson instance)

Inject the blueprint data access object which is used to obtain blueprint entities.

Parameters:

manager - topology manager

requestFactory - request factory

instance -

getServiceConfigVersionRequest

protected static ServiceConfigVersionRequest getServiceConfigVersionRequest(String parentCategory,
                                                                            Map<String,Object> properties)

Helper method for creating rollback request