org.apache.ambari.server.controller.internal

Class ComponentResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ComponentResourceProvider
extends AbstractControllerResourceProvider

Resource provider for component 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	CATEGORY
static String	CATEGORY_PROPERTY_ID
static String	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY_ID
static String	COMPONENT_NAME
static String	COMPONENT_NAME_PROPERTY_ID
static String	DESIRED_STACK
static String	DESIRED_STACK_PROPERTY_ID
static String	DESIRED_VERSION
static String	DESIRED_VERSION_PROPERTY_ID
static String	DISPLAY_NAME
static String	DISPLAY_NAME_PROPERTY_ID
static String	INIT_COUNT
static String	INIT_COUNT_PROPERTY_ID
static String	INSTALL_FAILED_COUNT
static String	INSTALL_FAILED_COUNT_PROPERTY_ID
static String	INSTALLED_AND_MAINTENANCE_OFF_COUNT
static String	INSTALLED_AND_MAINTENANCE_OFF_COUNT_PROPERTY_ID
static String	INSTALLED_COUNT
static String	INSTALLED_COUNT_PROPERTY_ID
static String	RECOVERY_ENABLED
static String	RECOVERY_ENABLED_PROPERTY_ID
static String	REPOSITORY_STATE
static String	REPOSITORY_STATE_PROPERTY_ID
static String	SERVICE_COMPONENT_INFO
static String	SERVICE_NAME
static String	SERVICE_NAME_PROPERTY_ID
static String	STARTED_COUNT
static String	STARTED_COUNT_PROPERTY_ID
static String	STATE
static String	STATE_PROPERTY_ID
static String	TOTAL_COUNT
static String	TOTAL_COUNT_PROPERTY_ID
static String	UNKNOWN_COUNT
static String	UNKNOWN_COUNT_PROPERTY_ID

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

keyPropertyIds, PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
void	createComponents(Set<ServiceComponentRequest> requests)
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 RequestStatusResponse	deleteComponents(Set<ServiceComponentRequest> requests)
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<ServiceComponentResponse>	getComponents(Set<ServiceComponentRequest> requests)
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 RequestStatusResponse	updateComponents(Set<ServiceComponentRequest> requests, Map<String,String> requestProperties, boolean runSmokeTest)
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, isAuthorizedToCreateResources, isAuthorizedToDeleteResources, 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, 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

SERVICE_COMPONENT_INFO

public static final String SERVICE_COMPONENT_INFO

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

SERVICE_NAME_PROPERTY_ID

public static final String SERVICE_NAME_PROPERTY_ID

See Also:

Constant Field Values

COMPONENT_NAME_PROPERTY_ID

public static final String COMPONENT_NAME_PROPERTY_ID

See Also:

Constant Field Values

DISPLAY_NAME_PROPERTY_ID

public static final String DISPLAY_NAME_PROPERTY_ID

See Also:

Constant Field Values

STATE_PROPERTY_ID

public static final String STATE_PROPERTY_ID

See Also:

Constant Field Values

CATEGORY_PROPERTY_ID

public static final String CATEGORY_PROPERTY_ID

See Also:

Constant Field Values

TOTAL_COUNT_PROPERTY_ID

public static final String TOTAL_COUNT_PROPERTY_ID

See Also:

Constant Field Values

STARTED_COUNT_PROPERTY_ID

public static final String STARTED_COUNT_PROPERTY_ID

See Also:

Constant Field Values

INSTALLED_COUNT_PROPERTY_ID

public static final String INSTALLED_COUNT_PROPERTY_ID

See Also:

Constant Field Values

INSTALLED_AND_MAINTENANCE_OFF_COUNT_PROPERTY_ID

public static final String INSTALLED_AND_MAINTENANCE_OFF_COUNT_PROPERTY_ID

See Also:

Constant Field Values

INIT_COUNT_PROPERTY_ID

public static final String INIT_COUNT_PROPERTY_ID

See Also:

Constant Field Values

UNKNOWN_COUNT_PROPERTY_ID

public static final String UNKNOWN_COUNT_PROPERTY_ID

See Also:

Constant Field Values

INSTALL_FAILED_COUNT_PROPERTY_ID

public static final String INSTALL_FAILED_COUNT_PROPERTY_ID

See Also:

Constant Field Values

RECOVERY_ENABLED_PROPERTY_ID

public static final String RECOVERY_ENABLED_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_STACK_PROPERTY_ID

public static final String DESIRED_STACK_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_VERSION_PROPERTY_ID

public static final String DESIRED_VERSION_PROPERTY_ID

See Also:

Constant Field Values

REPOSITORY_STATE_PROPERTY_ID

public static final String REPOSITORY_STATE_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

TOTAL_COUNT

public static final String TOTAL_COUNT

See Also:

Constant Field Values

STARTED_COUNT

public static final String STARTED_COUNT

See Also:

Constant Field Values

INSTALLED_COUNT

public static final String INSTALLED_COUNT

See Also:

Constant Field Values

INSTALLED_AND_MAINTENANCE_OFF_COUNT

public static final String INSTALLED_AND_MAINTENANCE_OFF_COUNT

See Also:

Constant Field Values

INIT_COUNT

public static final String INIT_COUNT

See Also:

Constant Field Values

UNKNOWN_COUNT

public static final String UNKNOWN_COUNT

See Also:

Constant Field Values

INSTALL_FAILED_COUNT

public static final String INSTALL_FAILED_COUNT

See Also:

Constant Field Values

RECOVERY_ENABLED

public static final String RECOVERY_ENABLED

See Also:

Constant Field Values

DESIRED_STACK

public static final String DESIRED_STACK

See Also:

Constant Field Values

DESIRED_VERSION

public static final String DESIRED_VERSION

See Also:

Constant Field Values

REPOSITORY_STATE

public static final String REPOSITORY_STATE

See Also:

Constant Field Values

Method Detail

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

public 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)

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

createComponents

public void createComponents(Set<ServiceComponentRequest> requests)
                      throws org.apache.ambari.server.AmbariException,
                             AuthorizationException

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException

getComponents

protected Set<ServiceComponentResponse> getComponents(Set<ServiceComponentRequest> requests)
                                               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

updateComponents

protected RequestStatusResponse updateComponents(Set<ServiceComponentRequest> requests,
                                                 Map<String,String> requestProperties,
                                                 boolean runSmokeTest)
                                          throws org.apache.ambari.server.AmbariException,
                                                 AuthorizationException

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException

deleteComponents

protected RequestStatusResponse deleteComponents(Set<ServiceComponentRequest> requests)
                                          throws org.apache.ambari.server.AmbariException,
                                                 AuthorizationException

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException