org.apache.ambari.server.controller.internal

Class HostResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class HostResourceProvider
extends AbstractControllerResourceProvider

Resource provider for host 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	ATTRIBUTES_PROPERTY_ID
static String	BLUEPRINT_PROPERTY_ID
static String	CLUSTER_NAME_PROPERTY_ID
static String	CPU_COUNT_PROPERTY_ID
static String	DESIRED_CONFIGS_PROPERTY_ID
static String	DISK_INFO_PROPERTY_ID
static String	HOST_ATTRIBUTES_PROPERTY_ID
static String	HOST_CLUSTER_NAME_PROPERTY_ID
static String	HOST_COUNT_PROPERTY_ID
static String	HOST_CPU_COUNT_PROPERTY_ID
static String	HOST_DESIRED_CONFIGS_PROPERTY_ID
static String	HOST_DISK_INFO_PROPERTY_ID
static String	HOST_GROUP_PROPERTY_ID
static String	HOST_HEALTH_REPORT_PROPERTY_ID
static String	HOST_HOST_HEALTH_REPORT_PROPERTY_ID
static String	HOST_HOST_NAME_PROPERTY_ID
static String	HOST_HOST_STATUS_PROPERTY_ID
static String	HOST_IP_PROPERTY_ID
static String	HOST_LAST_AGENT_ENV_PROPERTY_ID
static String	HOST_LAST_HEARTBEAT_TIME_PROPERTY_ID
static String	HOST_LAST_REGISTRATION_TIME_PROPERTY_ID
static String	HOST_MAINTENANCE_STATE_PROPERTY_ID
static String	HOST_NAME_PROPERTY_ID
static String	HOST_OS_ARCH_PROPERTY_ID
static String	HOST_OS_FAMILY_PROPERTY_ID
static String	HOST_OS_TYPE_PROPERTY_ID
static String	HOST_PHYSICAL_CPU_COUNT_PROPERTY_ID
static String	HOST_PREDICATE_PROPERTY_ID
static String	HOST_PUBLIC_NAME_PROPERTY_ID
static String	HOST_RACK_INFO_PROPERTY_ID
static String	HOST_RECOVERY_REPORT_PROPERTY_ID
static String	HOST_RECOVERY_SUMMARY_PROPERTY_ID
static String	HOST_STATE_PROPERTY_ID
static String	HOST_STATUS_PROPERTY_ID
static String	HOST_TOTAL_MEM_PROPERTY_ID
static String	IP_PROPERTY_ID
static Map<Resource.Type,String>	keyPropertyIds The key property ids for a Host resource.
static String	LAST_AGENT_ENV_PROPERTY_ID
static String	LAST_HEARTBEAT_TIME_PROPERTY_ID
static String	LAST_REGISTRATION_TIME_PROPERTY_ID
static String	MAINTENANCE_STATE_PROPERTY_ID
static String	OS_ARCH_PROPERTY_ID
static String	OS_FAMILY_PROPERTY_ID
static String	OS_TYPE_PROPERTY_ID
static String	PHYSICAL_CPU_COUNT_PROPERTY_ID
static Set<String>	propertyIds The property ids for a Host resource.
static String	PUBLIC_NAME_PROPERTY_ID
static String	RACK_INFO_PROPERTY_ID
static String	RECOVERY_REPORT_PROPERTY_ID
static String	RECOVERY_SUMMARY_PROPERTY_ID
static String	RESPONSE_KEY
static String	STATE_PROPERTY_ID
static String	TOTAL_MEM_PROPERTY_ID

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.
void	createHosts(Request request) Accepts a request with registered hosts and if the request contains a cluster name then will map all of the hosts onto that cluster.
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 DeleteStatusMetaData	deleteHosts(Set<HostRequest> requests, boolean dryRun)
protected RequestStatus	deleteResourcesAuthorized(Request request, Predicate predicate) Delete the resources selected by the given predicate if the authenticated user is authorized to do so.
static String	getHostNameFromProperties(Map<String,Object> properties) Obtain the hostname from the request properties.
protected static Set<HostResponse>	getHosts(AmbariManagementController controller, HostRequest request, OsFamily osFamily)
protected Set<HostResponse>	getHosts(Set<HostRequest> requests)
protected Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
protected Set<Resource>	getResourcesAuthorized(Request request, Predicate predicate) Get a set of resources based on the given request and predicate information if the authenticated user is authorized to do so.
RequestStatusResponse	install(String cluster, String hostname, Collection<String> skipInstallForComponents, Collection<String> dontSkipInstallForComponents, boolean skipFailure, boolean useClusterHostInfo)
static void	setTopologyManager(TopologyManager topologyManager)
RequestStatusResponse	start(String cluster, String hostname)
protected void	updateHosts(Set<HostRequest> requests)
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, getResources, 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, 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_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

CPU_COUNT_PROPERTY_ID

public static final String CPU_COUNT_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_CONFIGS_PROPERTY_ID

public static final String DESIRED_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

DISK_INFO_PROPERTY_ID

public static final String DISK_INFO_PROPERTY_ID

See Also:

Constant Field Values

HOST_HEALTH_REPORT_PROPERTY_ID

public static final String HOST_HEALTH_REPORT_PROPERTY_ID

See Also:

Constant Field Values

HOST_NAME_PROPERTY_ID

public static final String HOST_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOST_STATUS_PROPERTY_ID

public static final String HOST_STATUS_PROPERTY_ID

See Also:

Constant Field Values

IP_PROPERTY_ID

public static final String IP_PROPERTY_ID

See Also:

Constant Field Values

LAST_AGENT_ENV_PROPERTY_ID

public static final String LAST_AGENT_ENV_PROPERTY_ID

See Also:

Constant Field Values

LAST_HEARTBEAT_TIME_PROPERTY_ID

public static final String LAST_HEARTBEAT_TIME_PROPERTY_ID

See Also:

Constant Field Values

LAST_REGISTRATION_TIME_PROPERTY_ID

public static final String LAST_REGISTRATION_TIME_PROPERTY_ID

See Also:

Constant Field Values

MAINTENANCE_STATE_PROPERTY_ID

public static final String MAINTENANCE_STATE_PROPERTY_ID

See Also:

Constant Field Values

OS_ARCH_PROPERTY_ID

public static final String OS_ARCH_PROPERTY_ID

See Also:

Constant Field Values

OS_FAMILY_PROPERTY_ID

public static final String OS_FAMILY_PROPERTY_ID

See Also:

Constant Field Values

OS_TYPE_PROPERTY_ID

public static final String OS_TYPE_PROPERTY_ID

See Also:

Constant Field Values

PHYSICAL_CPU_COUNT_PROPERTY_ID

public static final String PHYSICAL_CPU_COUNT_PROPERTY_ID

See Also:

Constant Field Values

PUBLIC_NAME_PROPERTY_ID

public static final String PUBLIC_NAME_PROPERTY_ID

See Also:

Constant Field Values

RACK_INFO_PROPERTY_ID

public static final String RACK_INFO_PROPERTY_ID

See Also:

Constant Field Values

RECOVERY_REPORT_PROPERTY_ID

public static final String RECOVERY_REPORT_PROPERTY_ID

See Also:

Constant Field Values

RECOVERY_SUMMARY_PROPERTY_ID

public static final String RECOVERY_SUMMARY_PROPERTY_ID

See Also:

Constant Field Values

STATE_PROPERTY_ID

public static final String STATE_PROPERTY_ID

See Also:

Constant Field Values

TOTAL_MEM_PROPERTY_ID

public static final String TOTAL_MEM_PROPERTY_ID

See Also:

Constant Field Values

ATTRIBUTES_PROPERTY_ID

public static final String ATTRIBUTES_PROPERTY_ID

See Also:

Constant Field Values

HOST_CLUSTER_NAME_PROPERTY_ID

public static final String HOST_CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOST_CPU_COUNT_PROPERTY_ID

public static final String HOST_CPU_COUNT_PROPERTY_ID

See Also:

Constant Field Values

HOST_DESIRED_CONFIGS_PROPERTY_ID

public static final String HOST_DESIRED_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

HOST_DISK_INFO_PROPERTY_ID

public static final String HOST_DISK_INFO_PROPERTY_ID

See Also:

Constant Field Values

HOST_HOST_HEALTH_REPORT_PROPERTY_ID

public static final String HOST_HOST_HEALTH_REPORT_PROPERTY_ID

See Also:

Constant Field Values

HOST_HOST_STATUS_PROPERTY_ID

public static final String HOST_HOST_STATUS_PROPERTY_ID

See Also:

Constant Field Values

HOST_IP_PROPERTY_ID

public static final String HOST_IP_PROPERTY_ID

See Also:

Constant Field Values

HOST_LAST_AGENT_ENV_PROPERTY_ID

public static final String HOST_LAST_AGENT_ENV_PROPERTY_ID

See Also:

Constant Field Values

HOST_LAST_HEARTBEAT_TIME_PROPERTY_ID

public static final String HOST_LAST_HEARTBEAT_TIME_PROPERTY_ID

See Also:

Constant Field Values

HOST_LAST_REGISTRATION_TIME_PROPERTY_ID

public static final String HOST_LAST_REGISTRATION_TIME_PROPERTY_ID

See Also:

Constant Field Values

HOST_MAINTENANCE_STATE_PROPERTY_ID

public static final String HOST_MAINTENANCE_STATE_PROPERTY_ID

See Also:

Constant Field Values

HOST_HOST_NAME_PROPERTY_ID

public static final String HOST_HOST_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOST_OS_ARCH_PROPERTY_ID

public static final String HOST_OS_ARCH_PROPERTY_ID

See Also:

Constant Field Values

HOST_OS_FAMILY_PROPERTY_ID

public static final String HOST_OS_FAMILY_PROPERTY_ID

See Also:

Constant Field Values

HOST_OS_TYPE_PROPERTY_ID

public static final String HOST_OS_TYPE_PROPERTY_ID

See Also:

Constant Field Values

HOST_PHYSICAL_CPU_COUNT_PROPERTY_ID

public static final String HOST_PHYSICAL_CPU_COUNT_PROPERTY_ID

See Also:

Constant Field Values

HOST_PUBLIC_NAME_PROPERTY_ID

public static final String HOST_PUBLIC_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOST_RACK_INFO_PROPERTY_ID

public static final String HOST_RACK_INFO_PROPERTY_ID

See Also:

Constant Field Values

HOST_RECOVERY_REPORT_PROPERTY_ID

public static final String HOST_RECOVERY_REPORT_PROPERTY_ID

See Also:

Constant Field Values

HOST_RECOVERY_SUMMARY_PROPERTY_ID

public static final String HOST_RECOVERY_SUMMARY_PROPERTY_ID

See Also:

Constant Field Values

HOST_STATE_PROPERTY_ID

public static final String HOST_STATE_PROPERTY_ID

See Also:

Constant Field Values

HOST_TOTAL_MEM_PROPERTY_ID

public static final String HOST_TOTAL_MEM_PROPERTY_ID

See Also:

Constant Field Values

HOST_ATTRIBUTES_PROPERTY_ID

public static final String HOST_ATTRIBUTES_PROPERTY_ID

BLUEPRINT_PROPERTY_ID

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

public static final String HOST_COUNT_PROPERTY_ID

See Also:

Constant Field Values

HOST_PREDICATE_PROPERTY_ID

public static final String HOST_PREDICATE_PROPERTY_ID

See Also:

Constant Field Values

keyPropertyIds

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

The key property ids for a Host resource.

propertyIds

public static final Set<String> propertyIds

The property ids for a Host resource.

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)

getResourcesAuthorized

protected Set<Resource> getResourcesAuthorized(Request request,
                                               Predicate predicate)
                                        throws SystemException,
                                               NoSuchResourceException,
                                               NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Get a set of resources based on the given request and predicate information if the authenticated user is authorized to do so.

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

Overrides:

getResourcesAuthorized 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

NoSuchResourceException - the requested resource instance doesn't exist

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

See Also:

AbstractAuthorizedResourceProvider.getResources(Request, Predicate)

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)

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.

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

createHosts

public void createHosts(Request request)
                 throws org.apache.ambari.server.AmbariException,
                        AuthorizationException

Accepts a request with registered hosts and if the request contains a cluster name then will map all of the hosts onto that cluster.

Parameters:

request - Request that must contain registered hosts, and optionally a cluster.

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException

install

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

Throws:

SystemException

NoSuchParentResourceException

UnsupportedPropertyException

start

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

Throws:

SystemException

NoSuchParentResourceException

UnsupportedPropertyException

getHosts

protected Set<HostResponse> getHosts(Set<HostRequest> requests)
                              throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getHosts

protected static Set<HostResponse> getHosts(AmbariManagementController controller,
                                            HostRequest request,
                                            OsFamily osFamily)
                                     throws org.apache.ambari.server.AmbariException

Parameters:

osFamily - provides OS to OS family lookup; may be null if OS family is ignored anyway (eg. for liveness check)

Throws:

org.apache.ambari.server.AmbariException

updateHosts

protected void updateHosts(Set<HostRequest> requests)
                    throws org.apache.ambari.server.AmbariException,
                           AuthorizationException

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException

deleteHosts

protected DeleteStatusMetaData deleteHosts(Set<HostRequest> requests,
                                           boolean dryRun)
                                    throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getHostNameFromProperties

public static String getHostNameFromProperties(Map<String,Object> properties)

Obtain the hostname from the request properties. The hostname property name may differ depending on the request type. For the low level host resource creation calls, it is always "Hosts/host_name". For multi host "add host from hostgroup", the hostname property is a top level property "host_name".

Parameters:

properties - request properties

Returns:

the host name for the host request

setTopologyManager

public static void setTopologyManager(TopologyManager topologyManager)