org.apache.ambari.server.controller.internal

Class HostComponentResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class HostComponentResourceProvider
extends AbstractControllerResourceProvider

Resource provider for host 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	ACTUAL_CONFIGS
static String	ACTUAL_CONFIGS_PROPERTY_ID
static String	ALL_COMPONENTS
static String	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY_ID
static String	COMPONENT_NAME
static String	COMPONENT_NAME_PROPERTY_ID
static String	COMPONENT_PROPERTY_ID
static String	DESIRED_ADMIN_STATE
static String	DESIRED_ADMIN_STATE_PROPERTY_ID
static String	DESIRED_REPOSITORY_VERSION
static String	DESIRED_REPOSITORY_VERSION_PROPERTY_ID
static String	DESIRED_STACK_ID
static String	DESIRED_STACK_ID_PROPERTY_ID
static String	DESIRED_STATE
static String	DESIRED_STATE_PROPERTY_ID
static String	DISPLAY_NAME
static String	DISPLAY_NAME_PROPERTY_ID
static String	DO_NOT_SKIP_INSTALL_FOR_COMPONENTS
static String	FOR_ALL_COMPONENTS
static String	FOR_NO_COMPONENTS
static String	HOST
static String	HOST_NAME
static String	HOST_NAME_PROPERTY_ID
static String	HOST_PROPERTY_ID
static String	HOST_ROLES
static String	HREF_PROPERTY_ID
static Map<Resource.Type,String>	keyPropertyIds The key property ids for a HostComponent resource.
static String	MAINTENANCE_STATE
static String	MAINTENANCE_STATE_PROPERTY_ID
static String	METRICS_PROPERTY_ID
static String	PROCESSES_PROPERTY_ID
protected static Set<String>	propertyIds The property ids for a HostComponent resource.
static String	PUBLIC_HOST_NAME
static String	PUBLIC_HOST_NAME_PROPERTY_ID
static String	RELOAD_CONFIGS
static String	RELOAD_CONFIGS_PROPERTY_ID
static String	ROLE_ID
static String	ROLE_ID_PROPERTY_ID
static String	SERVICE_COMPONENT_INFO
static String	SERVICE_NAME
static String	SERVICE_NAME_PROPERTY_ID
static String	SKIP_INSTALL_FOR_COMPONENTS
static String	STALE_CONFIGS
static String	STALE_CONFIGS_PROPERTY_ID
static String	STATE
static String	STATE_PROPERTY_ID
static String	UPGRADE_STATE
static String	UPGRADE_STATE_PROPERTY_ID
static String	VERSION
static String	VERSION_PROPERTY_ID

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

PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Constructor and Description
HostComponentResourceProvider(AmbariManagementController managementController) Create a new resource provider for the given management controller.

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.
RequestStageContainer	doUpdateResources(RequestStageContainer stages, Request request, Predicate predicate, boolean performQueryEvaluation, boolean useGeneratedConfigs, boolean useClusterHostInfo) Update resources.
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.
RequestStatusResponse	install(String cluster, String hostname, Collection<String> skipInstallForComponents, Collection<String> dontSkipInstallForComponents, boolean skipFailure, boolean useClusterHostInfo)
boolean	isDirectTransition(State oldState, State newState) Checks if assigning new state does not require performing any additional actions
static String	joinComponentList(Collection<String> components)
static boolean	shouldSkipInstallTaskForComponent(String componentName, boolean isClientComponent, Map<String,String> requestProperties)
RequestStatusResponse	start(String cluster, String hostName)
RequestStatusResponse	start(String cluster, String hostName, Collection<String> installOnlyComponents, boolean skipFailure, boolean useClusterHostInfo)
protected RequestStageContainer	updateHostComponents(RequestStageContainer stages, Set<ServiceComponentHostRequest> requests, Map<String,String> requestProperties, boolean runSmokeTest, boolean useGeneratedConfigs, boolean useClusterHostInfo) Update the host component identified by the given request object with the values carried by the given request object.
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

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

HOST_ROLES

public static final String HOST_ROLES

See Also:

Constant Field Values

HOST

public static final String HOST

See Also:

Constant Field Values

SERVICE_COMPONENT_INFO

public static final String SERVICE_COMPONENT_INFO

See Also:

Constant Field Values

ROLE_ID_PROPERTY_ID

public static final String ROLE_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

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

HOST_NAME_PROPERTY_ID

public static final String HOST_NAME_PROPERTY_ID

See Also:

Constant Field Values

PUBLIC_HOST_NAME_PROPERTY_ID

public static final String PUBLIC_HOST_NAME_PROPERTY_ID

See Also:

Constant Field Values

STATE_PROPERTY_ID

public static final String STATE_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_STATE_PROPERTY_ID

public static final String DESIRED_STATE_PROPERTY_ID

See Also:

Constant Field Values

VERSION_PROPERTY_ID

public static final String VERSION_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_STACK_ID_PROPERTY_ID

public static final String DESIRED_STACK_ID_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_REPOSITORY_VERSION_PROPERTY_ID

public static final String DESIRED_REPOSITORY_VERSION_PROPERTY_ID

See Also:

Constant Field Values

ACTUAL_CONFIGS_PROPERTY_ID

public static final String ACTUAL_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

STALE_CONFIGS_PROPERTY_ID

public static final String STALE_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

RELOAD_CONFIGS_PROPERTY_ID

public static final String RELOAD_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_ADMIN_STATE_PROPERTY_ID

public static final String DESIRED_ADMIN_STATE_PROPERTY_ID

See Also:

Constant Field Values

MAINTENANCE_STATE_PROPERTY_ID

public static final String MAINTENANCE_STATE_PROPERTY_ID

See Also:

Constant Field Values

UPGRADE_STATE_PROPERTY_ID

public static final String UPGRADE_STATE_PROPERTY_ID

See Also:

Constant Field Values

HOST_PROPERTY_ID

public static final String HOST_PROPERTY_ID

See Also:

Constant Field Values

HREF_PROPERTY_ID

public static final String HREF_PROPERTY_ID

See Also:

Constant Field Values

COMPONENT_PROPERTY_ID

public static final String COMPONENT_PROPERTY_ID

See Also:

Constant Field Values

METRICS_PROPERTY_ID

public static final String METRICS_PROPERTY_ID

See Also:

Constant Field Values

PROCESSES_PROPERTY_ID

public static final String PROCESSES_PROPERTY_ID

See Also:

Constant Field Values

ROLE_ID

public static final String ROLE_ID

CLUSTER_NAME

public static final String CLUSTER_NAME

SERVICE_NAME

public static final String SERVICE_NAME

COMPONENT_NAME

public static final String COMPONENT_NAME

DISPLAY_NAME

public static final String DISPLAY_NAME

HOST_NAME

public static final String HOST_NAME

PUBLIC_HOST_NAME

public static final String PUBLIC_HOST_NAME

STATE

public static final String STATE

DESIRED_STATE

public static final String DESIRED_STATE

VERSION

public static final String VERSION

DESIRED_STACK_ID

public static final String DESIRED_STACK_ID

DESIRED_REPOSITORY_VERSION

public static final String DESIRED_REPOSITORY_VERSION

ACTUAL_CONFIGS

public static final String ACTUAL_CONFIGS

STALE_CONFIGS

public static final String STALE_CONFIGS

RELOAD_CONFIGS

public static final String RELOAD_CONFIGS

DESIRED_ADMIN_STATE

public static final String DESIRED_ADMIN_STATE

MAINTENANCE_STATE

public static final String MAINTENANCE_STATE

UPGRADE_STATE

public static final String UPGRADE_STATE

keyPropertyIds

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

The key property ids for a HostComponent resource.

propertyIds

protected static final Set<String> propertyIds

The property ids for a HostComponent resource.

SKIP_INSTALL_FOR_COMPONENTS

public static final String SKIP_INSTALL_FOR_COMPONENTS

See Also:

Constant Field Values

DO_NOT_SKIP_INSTALL_FOR_COMPONENTS

public static final String DO_NOT_SKIP_INSTALL_FOR_COMPONENTS

See Also:

Constant Field Values

ALL_COMPONENTS

public static final String ALL_COMPONENTS

See Also:

Constant Field Values

FOR_ALL_COMPONENTS

public static final String FOR_ALL_COMPONENTS

FOR_NO_COMPONENTS

public static final String FOR_NO_COMPONENTS

Constructor Detail

HostComponentResourceProvider

public HostComponentResourceProvider(AmbariManagementController managementController)

Create a new resource provider for the given management controller.

Parameters:

managementController - the management controller

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

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

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)

checkPropertyIds

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

Description copied from interface: ResourceProvider

Check whether the set of given property ids is supported by this resource provider.

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.

install

public RequestStatusResponse install(String cluster,
                                     String hostname,
                                     Collection<String> skipInstallForComponents,
                                     Collection<String> dontSkipInstallForComponents,
                                     boolean skipFailure,
                                     boolean useClusterHostInfo)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchParentResourceException

Throws:

SystemException

UnsupportedPropertyException

NoSuchParentResourceException

joinComponentList

public static String joinComponentList(Collection<String> components)

shouldSkipInstallTaskForComponent

public static boolean shouldSkipInstallTaskForComponent(String componentName,
                                                        boolean isClientComponent,
                                                        Map<String,String> requestProperties)

start

public RequestStatusResponse start(String cluster,
                                   String hostName)
                            throws SystemException,
                                   UnsupportedPropertyException,
                                   NoSuchParentResourceException

Throws:

SystemException

UnsupportedPropertyException

NoSuchParentResourceException

start

public RequestStatusResponse start(String cluster,
                                   String hostName,
                                   Collection<String> installOnlyComponents,
                                   boolean skipFailure,
                                   boolean useClusterHostInfo)
                            throws SystemException,
                                   UnsupportedPropertyException,
                                   NoSuchParentResourceException

Throws:

SystemException

UnsupportedPropertyException

NoSuchParentResourceException

updateHostComponents

protected RequestStageContainer updateHostComponents(RequestStageContainer stages,
                                                     Set<ServiceComponentHostRequest> requests,
                                                     Map<String,String> requestProperties,
                                                     boolean runSmokeTest,
                                                     boolean useGeneratedConfigs,
                                                     boolean useClusterHostInfo)
                                              throws org.apache.ambari.server.AmbariException,
                                                     AuthorizationException

Update the host component identified by the given request object with the values carried by the given request object.

Parameters:

stages - stages of the associated request

requests - the request object which defines which host component to update and the values to set

requestProperties - the request properties

runSmokeTest - indicates whether or not to run a smoke test

Returns:

a track action response

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be updated

AuthorizationException

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

doUpdateResources

public RequestStageContainer doUpdateResources(RequestStageContainer stages,
                                               Request request,
                                               Predicate predicate,
                                               boolean performQueryEvaluation,
                                               boolean useGeneratedConfigs,
                                               boolean useClusterHostInfo)
                                        throws UnsupportedPropertyException,
                                               SystemException,
                                               NoSuchResourceException,
                                               NoSuchParentResourceException

Update resources.

Parameters:

stages - request stage container

request - request

predicate - request predicate

performQueryEvaluation - should query be evaluated for matching resource set

useGeneratedConfigs - should update request contains actual configs

useClusterHostInfo - should update request contain cluster topology info

Returns:

Throws:

UnsupportedPropertyException - an unsupported property was specified in the request

SystemException - an unknown exception occurred

NoSuchResourceException - the query didn't match any resources

NoSuchParentResourceException - a specified parent resource doesn't exist

isDirectTransition

public boolean isDirectTransition(State oldState,
                                  State newState)

Checks if assigning new state does not require performing any additional actions