org.apache.ambari.server.state.cluster

Class ClusterImpl

java.lang.Object

org.apache.ambari.server.state.cluster.ClusterImpl

All Implemented Interfaces:

Cluster

public class ClusterImpl
extends Object
implements Cluster

Constructor Summary

Constructors

Constructor and Description
ClusterImpl(ClusterEntity clusterEntity, com.google.inject.Injector injector, AmbariEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
void	addConfig(Config config) Sets a specific config.
void	addConfigGroup(ConfigGroup configGroup) Add a new config group to the set of Config groups associated with this cluster
ServiceConfigVersionResponse	addDesiredConfig(String user, Set<Config> configs) Adds and sets a DESIRED configuration to be applied to a cluster.
ServiceConfigVersionResponse	addDesiredConfig(String user, Set<Config> configs, String serviceConfigVersionNote) Adds and sets a DESIRED configuration to be applied to a cluster.
void	addRequestExecution(RequestExecution requestExecution) Add a @RequestExecution to the cluster
void	addService(Service service) Add a service to a cluster
Service	addService(String serviceName, RepositoryVersionEntity repositoryVersion) Add service to the cluster
void	addServiceComponentHost(ServiceComponentHost svcCompHost)
void	addServiceComponentHosts(Collection<ServiceComponentHost> serviceComponentHosts) Adds schs to cluster AND persists them TODO consider making persisting optional
void	addSessionAttributes(Map<String,Object> attributes) Add the given map of attributes to the session for this cluster.
void	addSuspendedUpgradeParameters(Map<String,String> commandParams, Map<String,String> roleParams) Adds upgrade specific command and role parameters to the command maps if there is a suspended upgrade.
void	applyLatestConfigurations(StackId stackId, String serviceName) Makes the most recent configurations for the specified stack current.
org.apache.ambari.spi.ClusterInformation	buildClusterInformation() Builds a ClusterInformation instance from a Cluster.
boolean	canBeRemoved() Gets if the cluster can be deleted
boolean	checkPermission(PrivilegeEntity privilegeEntity, boolean readOnly) Determine whether or not access to this cluster resource should be allowed based on the given privilege.
ClusterResponse	convertToResponse() Creates a cluster response based on the current cluster definition
ServiceConfigVersionResponse	createServiceConfigVersion(String serviceName, String user, String note, ConfigGroup configGroup)
void	debugDump(StringBuilder sb) Creates a debug dump based on the current cluster state
void	delete() Delete the cluster
void	deleteAllServices() Delete all the services associated with this cluster
void	deleteConfigGroup(Long id) Delete this config group identified by the config group id
void	deleteRequestExecution(Long id) Delete a @RequestExecution associated with the cluster
void	deleteService(String serviceName, DeleteHostComponentStatusMetaData deleteMetaData) Delete the named service associated with this cluster
List<ServiceConfigVersionResponse>	getActiveServiceConfigVersionResponse(String serviceName) Get active service config version responses for all config groups of a service
Map<String,Collection<ServiceConfigVersionResponse>>	getActiveServiceConfigVersions() Get currently active service config versions for stack services
Collection<Config>	getAllConfigs() Gets all configurations defined for a cluster.
Map<String,Set<DesiredConfig>>	getAllDesiredConfigVersions() Gets all versions of the desired configurations for the cluster.
Map<Long,Map<String,DesiredConfig>>	getAllHostsDesiredConfigs() Fetch desired configs for all hosts in cluster
Map<Long,RequestExecution>	getAllRequestExecutions() Get all @RequestExecution objects associated with the cluster
ClusterEntity	getClusterEntity() Gets the ClusterEntity for this Cluster from the EntityManager cache.
long	getClusterId() Get the cluster ID
String	getClusterName() Get the Cluster Name
String	getClusterProperty(String propertyName, String defaultValue) Gets the most recent value of cluster-env/propertyName where propertyName is the paramter specified to the method.
int	getClusterSize() Returns the number of hosts that form the cluster.
Map<String,Map<String,String>>	getComponentVersionMap() Gets a mapping of service to component/version for every installed component in the cluster which advertises a version and for which the repository has been resolved.
Config	getConfig(String configType, String versionTag) Gets the specific config that matches the specified type and tag.
Config	getConfigByVersion(String configType, Long configVersion) Gets the specific config that matches the specified type and version.
Map<Long,ConfigGroup>	getConfigGroups() Get config groups associated with this cluster
Map<Long,ConfigGroup>	getConfigGroupsByHostname(String hostname) Find all config groups associated with the give hostname
ConfigGroup	getConfigGroupsById(Long configId) Find config group by config group id
Map<Long,ConfigGroup>	getConfigGroupsByServiceName(String serviceName) Find all config groups associated with the give service name
Map<PropertyInfo.PropertyType,Set<String>>	getConfigPropertiesTypes(String configType) Gets all properties types that matches the specified type for the current stack.
Map<PropertyInfo.PropertyType,Set<String>>	getConfigPropertiesTypes(String configType, StackId stackId) Gets all properties types that matches the specified type for the given stack.
Map<String,Config>	getConfigsByType(String configType) Gets all configs that match the specified type.
StackId	getCurrentStackVersion() Get current stack version
Config	getDesiredConfigByType(String configType) Gets the desired (and selected) config by type.
Map<String,DesiredConfig>	getDesiredConfigs() Gets the active desired configurations for the cluster.
Map<String,DesiredConfig>	getDesiredConfigs(boolean cachedConfigEntities) Gets the active desired configurations for the cluster.
StackId	getDesiredStackVersion() Get desired stack version
Host	getHost(Long hostId) Get specific host info using host id.
Host	getHost(String hostName) Get specific host info using host name.
Collection<Host>	getHosts() Get all hosts associated with this cluster.
Set<String>	getHosts(String serviceName, String componentName) Get all of the hosts running the provided service and component.
Map<Long,Map<String,DesiredConfig>>	getHostsDesiredConfigs(Collection<Long> hostIds) Fetch desired configs for list of hosts in cluster
List<Config>	getLatestConfigsWithTypes(Collection<String> types) Get latest (including inactive ones) configurations with any of the given types.
Long	getNextConfigVersion(String type) Get next version of specified config type
State	getProvisioningState() Gets whether the cluster is still initializing or has finished with its deployment requests.
Long	getResourceId() Gets the Cluster's resource ID
RoleCommandOrder	getRoleCommandOrder() Gets a new instance of a RoleCommandOrder for this cluster.
SecurityType	getSecurityType() Gets the cluster's security type.
Service	getService(String serviceName) Get a service
Service	getServiceByComponentName(String componentName) Gets a service from the given component name.
String	getServiceByConfigType(String configType) Returns the name of the service that the passed config type belongs to.
ServiceComponentHost	getServiceComponentHost(String serviceName, String serviceComponentName, String hostname)
Map<String,Set<String>>	getServiceComponentHostMap(Set<String> hostNames, Set<String> serviceNames) Gets a map of components to hosts they are installed on.
List<ServiceComponentHost>	getServiceComponentHosts() Get all ServiceComponentHosts for this cluster.
List<ServiceComponentHost>	getServiceComponentHosts(String hostname) Get all ServiceComponentHosts on a given host
List<ServiceComponentHost>	getServiceComponentHosts(String serviceName, String componentName) Get all ServiceComponentHosts for a given service and optional component If the component name is null, all components for the requested service will be returned.
List<ServiceConfigVersionResponse>	getServiceConfigVersions() Get service config version history
String	getServiceForConfigTypes(Collection<String> configTypes)
Map<String,Service>	getServices() Get all services
Map<String,Object>	getSessionAttributes() Get the map of session attributes for this cluster.
protected AmbariSessionManager	getSessionManager() Get the associated session manager.
UpgradeEntity	getUpgradeInProgress() Gets an UpgradeEntity if there is an upgrade in progress or an upgrade that has been suspended.
void	handleClusterEnvConfigChangedEvent(ClusterConfigChangedEvent event) Handles ClusterConfigChangedEvent which means that the {{cluster-env}} may have changed.
boolean	isBluePrintDeployed() Returns whether this cluster was provisioned by a Blueprint or not.
boolean	isConfigTypeExists(String configType) Check if config type exists in cluster.
boolean	isUpgradeSuspended() Gets whether there is an upgrade which has been suspended and not yet finalized.
void	onClusterProvisioned(ClusterProvisionedEvent event)
Map<ServiceComponentHostEvent,String>	processServiceComponentHostEvents(com.google.common.collect.ListMultimap<String,ServiceComponentHostEvent> eventMap) Bulk handle service component host events
protected Map<ServiceComponentHostEvent,String>	processServiceComponentHostEventsInSingleTransaction(com.google.common.collect.ListMultimap<String,ServiceComponentHostEvent> eventMap) Bulk handle service component host events, wrapping all handling in a single transaction.
void	refresh() Refreshes the cluster details
void	removeConfigurations(StackId stackId, String serviceName) Removes all configurations for the specified service and stack.
protected void	removeEntities()
void	removeServiceComponentHost(ServiceComponentHost svcCompHost) Remove ServiceComponentHost from cluster
void	removeSessionAttribute(String key) Removes an attribute from the session for this cluster
List<String>	serviceNameByConfigType(String configType)
void	setClusterName(String clusterName) Set the Cluster Name
void	setCurrentStackVersion(StackId stackId) Set current stack version
void	setDesiredStackVersion(StackId stackId) Set desired stack version
void	setProvisioningState(State provisioningState) Sets the provisioning state of the cluster.
void	setSecurityType(SecurityType securityType) Sets this Cluster's security type.
ServiceConfigVersionResponse	setServiceConfigVersion(String serviceName, Long version, String user, String note) Apply specified service config version (rollback)
void	setSessionAttribute(String key, Object value) Sets or adds an attribute in the session for this cluster
void	setUpgradeEntity(UpgradeEntity upgradeEntity) Sets or clears the associated upgrade with the cluster.
List<Host>	transitionHostsToInstalling(RepositoryVersionEntity repoVersionEntity, VersionDefinitionXml versionDefinitionXml, boolean forceInstalled) Creates or updates host versions for all of the hosts within a cluster based on state of cluster stack version.

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.state.Cluster

getHostNames

Constructor Detail

ClusterImpl

@Inject
public ClusterImpl(ClusterEntity clusterEntity,
                           com.google.inject.Injector injector,
                           AmbariEventPublisher eventPublisher)
                    throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

Method Detail

addConfigGroup

public void addConfigGroup(ConfigGroup configGroup)
                    throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Add a new config group to the set of Config groups associated with this cluster

Specified by:

addConfigGroup in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getConfigGroups

public Map<Long,ConfigGroup> getConfigGroups()

Description copied from interface: Cluster

Get config groups associated with this cluster

Specified by:

getConfigGroups in interface Cluster

Returns:

unmodifiable map of config group id to config group. Will not return null.

getConfigGroupsByHostname

public Map<Long,ConfigGroup> getConfigGroupsByHostname(String hostname)
                                                throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Find all config groups associated with the give hostname

Specified by:

getConfigGroupsByHostname in interface Cluster

Returns:

Map of config group id to config group

Throws:

org.apache.ambari.server.AmbariException

getConfigGroupsById

public ConfigGroup getConfigGroupsById(Long configId)

Description copied from interface: Cluster

Find config group by config group id

Specified by:

getConfigGroupsById in interface Cluster

Parameters:

configId - id of config group to return

Returns:

config group

getConfigGroupsByServiceName

public Map<Long,ConfigGroup> getConfigGroupsByServiceName(String serviceName)

Description copied from interface: Cluster

Find all config groups associated with the give service name

Specified by:

getConfigGroupsByServiceName in interface Cluster

Returns:

Map of config group id to config group

addRequestExecution

public void addRequestExecution(RequestExecution requestExecution)
                         throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Add a @RequestExecution to the cluster

Specified by:

addRequestExecution in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getAllRequestExecutions

public Map<Long,RequestExecution> getAllRequestExecutions()

Description copied from interface: Cluster

Get all @RequestExecution objects associated with the cluster

Specified by:

getAllRequestExecutions in interface Cluster

Returns:

deleteRequestExecution

public void deleteRequestExecution(Long id)
                            throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Delete a @RequestExecution associated with the cluster

Specified by:

deleteRequestExecution in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

deleteConfigGroup

public void deleteConfigGroup(Long id)
                       throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Delete this config group identified by the config group id

Specified by:

deleteConfigGroup in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getServiceComponentHost

public ServiceComponentHost getServiceComponentHost(String serviceName,
                                                    String serviceComponentName,
                                                    String hostname)
                                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getServiceComponentHosts

public List<ServiceComponentHost> getServiceComponentHosts()

Description copied from interface: Cluster

Get all ServiceComponentHosts for this cluster.

Specified by:

getServiceComponentHosts in interface Cluster

getClusterName

public String getClusterName()

Description copied from interface: Cluster

Get the Cluster Name

Specified by:

getClusterName in interface Cluster

setClusterName

public void setClusterName(String clusterName)

Description copied from interface: Cluster

Set the Cluster Name

Specified by:

setClusterName in interface Cluster

getResourceId

public Long getResourceId()

Description copied from interface: Cluster

Gets the Cluster's resource ID

Specified by:

getResourceId in interface Cluster

addServiceComponentHosts

public void addServiceComponentHosts(Collection<ServiceComponentHost> serviceComponentHosts)
                              throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Adds schs to cluster AND persists them TODO consider making persisting optional

Specified by:

addServiceComponentHosts in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

addServiceComponentHost

public void addServiceComponentHost(ServiceComponentHost svcCompHost)
                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

removeServiceComponentHost

public void removeServiceComponentHost(ServiceComponentHost svcCompHost)
                                throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Remove ServiceComponentHost from cluster

Specified by:

removeServiceComponentHost in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getClusterId

public long getClusterId()

Description copied from interface: Cluster

Get the cluster ID

Specified by:

getClusterId in interface Cluster

getServiceComponentHosts

public List<ServiceComponentHost> getServiceComponentHosts(String hostname)

Description copied from interface: Cluster

Get all ServiceComponentHosts on a given host

Specified by:

getServiceComponentHosts in interface Cluster

Returns:

getServiceComponentHostMap

public Map<String,Set<String>> getServiceComponentHostMap(Set<String> hostNames,
                                                          Set<String> serviceNames)

Description copied from interface: Cluster

Gets a map of components to hosts they are installed on.

This may may be filtered by host and/or service by optionally providing a set of hostname and/or service names to use as a filter. null for either filter indicates no filter (or all), an empty set indicates a complete filter (or none).

Specified by:

getServiceComponentHostMap in interface Cluster

Returns:

a map of (filtered) components to hosts

getServiceComponentHosts

public List<ServiceComponentHost> getServiceComponentHosts(String serviceName,
                                                           String componentName)

Description copied from interface: Cluster

Get all ServiceComponentHosts for a given service and optional component If the component name is null, all components for the requested service will be returned.

Specified by:

getServiceComponentHosts in interface Cluster

Parameters:

serviceName - the name a the desired service

componentName - the name a the desired component - null indicates all components for the service

Returns:

a list of found ServiceComponentHost instances

addService

public void addService(Service service)

Description copied from interface: Cluster

Add a service to a cluster

Specified by:

addService in interface Cluster

addService

public Service addService(String serviceName,
                          RepositoryVersionEntity repositoryVersion)
                   throws org.apache.ambari.server.AmbariException

Add service to the cluster

Specified by:

addService in interface Cluster

Parameters:

serviceName - the name of the service to add (not null).

repositoryVersion - the repository from which the service should be installed (not null).

Returns:

Throws:

org.apache.ambari.server.AmbariException

getService

public Service getService(String serviceName)
                   throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Get a service

Specified by:

getService in interface Cluster

Returns:

Throws:

org.apache.ambari.server.AmbariException

getServices

public Map<String,Service> getServices()

Description copied from interface: Cluster

Get all services

Specified by:

getServices in interface Cluster

Returns:

getServiceByComponentName

public Service getServiceByComponentName(String componentName)
                                  throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Gets a service from the given component name.

Specified by:

getServiceByComponentName in interface Cluster

Returns:

Throws:

org.apache.ambari.server.AmbariException

getDesiredStackVersion

public StackId getDesiredStackVersion()

Description copied from interface: Cluster

Get desired stack version

Specified by:

getDesiredStackVersion in interface Cluster

Returns:

setDesiredStackVersion

public void setDesiredStackVersion(StackId stackId)
                            throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Set desired stack version

Specified by:

setDesiredStackVersion in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getCurrentStackVersion

public StackId getCurrentStackVersion()

Description copied from interface: Cluster

Get current stack version

Specified by:

getCurrentStackVersion in interface Cluster

Returns:

getProvisioningState

public State getProvisioningState()

Description copied from interface: Cluster

Gets whether the cluster is still initializing or has finished with its deployment requests.

Specified by:

getProvisioningState in interface Cluster

Returns:

either State.INIT or State.INSTALLED, never null.

setProvisioningState

public void setProvisioningState(State provisioningState)

Description copied from interface: Cluster

Sets the provisioning state of the cluster.

Specified by:

setProvisioningState in interface Cluster

Parameters:

provisioningState - the provisioning state, not null.

getSecurityType

public SecurityType getSecurityType()

Description copied from interface: Cluster

Gets the cluster's security type.

Specified by:

getSecurityType in interface Cluster

Returns:

this Cluster's security type

setSecurityType

public void setSecurityType(SecurityType securityType)

Description copied from interface: Cluster

Sets this Cluster's security type.

Specified by:

setSecurityType in interface Cluster

Parameters:

securityType - a SecurityType to set

transitionHostsToInstalling

public List<Host> transitionHostsToInstalling(RepositoryVersionEntity repoVersionEntity,
                                              VersionDefinitionXml versionDefinitionXml,
                                              boolean forceInstalled)
                                       throws org.apache.ambari.server.AmbariException

Creates or updates host versions for all of the hosts within a cluster based on state of cluster stack version. This is used to transition all hosts into the correct state (which may not be RepositoryVersionState.INSTALLING).

Hosts that are in maintenance mode will be transitioned directly into RepositoryVersionState.OUT_OF_SYNC instead. Hosts which do not need the version distributed to them will move into the RepositoryVersionState.NOT_REQUIRED state.

Specified by:

transitionHostsToInstalling in interface Cluster

Parameters:

repoVersionEntity - the repository that the hosts are being transitioned for (not null).

versionDefinitionXml - the VDF, or null if none.

forceInstalled - if true, then this will transition everything directly to RepositoryVersionState.INSTALLED instead of RepositoryVersionState.INSTALLING. Hosts which should received other states (like RepositoryVersionState.NOT_REQUIRED will continue to receive those states.

Returns:

a list of hosts which need the repository installed.

Throws:

org.apache.ambari.server.AmbariException

setCurrentStackVersion

public void setCurrentStackVersion(StackId stackId)
                            throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Set current stack version

Specified by:

setCurrentStackVersion in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getConfigsByType

public Map<String,Config> getConfigsByType(String configType)

Description copied from interface: Cluster

Gets all configs that match the specified type. Result is not the DESIRED configuration for a cluster.

Specified by:

getConfigsByType in interface Cluster

Parameters:

configType - the config type to return

Returns:

a map of configuration objects that have been set for the given type

getConfig

public Config getConfig(String configType,
                        String versionTag)

Description copied from interface: Cluster

Gets the specific config that matches the specified type and tag. This not necessarily a DESIRED configuration that applies to a cluster.

Specified by:

getConfig in interface Cluster

Parameters:

configType - the config type to find

versionTag - the config version tag to find

Returns:

a Config object, or null if the specific type and version have not been set.

getLatestConfigsWithTypes

public List<Config> getLatestConfigsWithTypes(Collection<String> types)

Description copied from interface: Cluster

Get latest (including inactive ones) configurations with any of the given types. This method does not take into account the configuration being enabled.

Specified by:

getLatestConfigsWithTypes in interface Cluster

Returns:

the list of configurations with the given types

getConfigByVersion

public Config getConfigByVersion(String configType,
                                 Long configVersion)

Description copied from interface: Cluster

Gets the specific config that matches the specified type and version. This not necessarily a DESIRED configuration that applies to a cluster.

Specified by:

getConfigByVersion in interface Cluster

Parameters:

configType - the config type to find

configVersion - the config version to find

Returns:

a Config object, or null if the specific type and version have not been set.

addConfig

public void addConfig(Config config)

Description copied from interface: Cluster

Sets a specific config. NOTE: This is not a DESIRED configuration that applies to a cluster.

Specified by:

addConfig in interface Cluster

Parameters:

config - the config instance to add

getAllConfigs

public Collection<Config> getAllConfigs()

Description copied from interface: Cluster

Gets all configurations defined for a cluster.

Specified by:

getAllConfigs in interface Cluster

Returns:

the collection of all configs that have been defined.

convertToResponse

public ClusterResponse convertToResponse()
                                  throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Creates a cluster response based on the current cluster definition

Specified by:

convertToResponse in interface Cluster

Returns:

Throws:

org.apache.ambari.server.AmbariException

debugDump

public void debugDump(StringBuilder sb)

Description copied from interface: Cluster

Creates a debug dump based on the current cluster state

Specified by:

debugDump in interface Cluster

refresh

public void refresh()

Description copied from interface: Cluster

Refreshes the cluster details

Specified by:

refresh in interface Cluster

deleteAllServices

public void deleteAllServices()
                       throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Delete all the services associated with this cluster

Specified by:

deleteAllServices in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

deleteService

public void deleteService(String serviceName,
                          DeleteHostComponentStatusMetaData deleteMetaData)
                   throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Delete the named service associated with this cluster

Specified by:

deleteService in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

canBeRemoved

public boolean canBeRemoved()

Description copied from interface: Cluster

Gets if the cluster can be deleted

Specified by:

canBeRemoved in interface Cluster

Returns:

delete

public void delete()
            throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Delete the cluster

Specified by:

delete in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

removeEntities

protected void removeEntities()
                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

addDesiredConfig

public ServiceConfigVersionResponse addDesiredConfig(String user,
                                                     Set<Config> configs)
                                              throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Adds and sets a DESIRED configuration to be applied to a cluster. There can be only one selected config per type.

Specified by:

addDesiredConfig in interface Cluster

Parameters:

user - the user making the change for audit purposes

configs - the set of Config objects to set as desired

Returns:

true if the config was added, or false if the config is already set as the current

Throws:

org.apache.ambari.server.AmbariException

addDesiredConfig

public ServiceConfigVersionResponse addDesiredConfig(String user,
                                                     Set<Config> configs,
                                                     String serviceConfigVersionNote)
                                              throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Adds and sets a DESIRED configuration to be applied to a cluster. There can be only one selected config per type.

Specified by:

addDesiredConfig in interface Cluster

Parameters:

user - the user making the change for audit purposes

configs - the set of Config objects to set as desired

serviceConfigVersionNote - note to attach to service config version if created

Returns:

true if the config was added, or false if the config is already set as the current

Throws:

org.apache.ambari.server.AmbariException

getAllDesiredConfigVersions

public Map<String,Set<DesiredConfig>> getAllDesiredConfigVersions()

Gets all versions of the desired configurations for the cluster.

Specified by:

getAllDesiredConfigVersions in interface Cluster

Returns:

a map of type-to-configuration information.

getDesiredConfigs

public Map<String,DesiredConfig> getDesiredConfigs()

Description copied from interface: Cluster

Gets the active desired configurations for the cluster.

Specified by:

getDesiredConfigs in interface Cluster

Returns:

a map of type-to-configuration information.

getDesiredConfigs

public Map<String,DesiredConfig> getDesiredConfigs(boolean cachedConfigEntities)

Description copied from interface: Cluster

Gets the active desired configurations for the cluster.

Specified by:

getDesiredConfigs in interface Cluster

Parameters:

cachedConfigEntities - retrieves cluster config entities from the cache if true, otherwise from the DB directly.

Returns:

a map of type-to-configuration information.

createServiceConfigVersion

public ServiceConfigVersionResponse createServiceConfigVersion(String serviceName,
                                                               String user,
                                                               String note,
                                                               ConfigGroup configGroup)
                                                        throws org.apache.ambari.server.AmbariException

Specified by:

createServiceConfigVersion in interface Cluster

Throws:

org.apache.ambari.server.AmbariException

getServiceForConfigTypes

public String getServiceForConfigTypes(Collection<String> configTypes)

Specified by:

getServiceForConfigTypes in interface Cluster

serviceNameByConfigType

public List<String> serviceNameByConfigType(String configType)

getServiceByConfigType

public String getServiceByConfigType(String configType)

Description copied from interface: Cluster

Returns the name of the service that the passed config type belongs to.

Specified by:

getServiceByConfigType in interface Cluster

Parameters:

configType - the config type to look up the service by

Returns:

returns the name of the service that the config type belongs to if there is any otherwise returns null.

setServiceConfigVersion

public ServiceConfigVersionResponse setServiceConfigVersion(String serviceName,
                                                            Long version,
                                                            String user,
                                                            String note)
                                                     throws org.apache.ambari.server.AmbariException

Description copied from interface: Cluster

Apply specified service config version (rollback)

Specified by:

setServiceConfigVersion in interface Cluster

Parameters:

serviceName - service name

version - service config version

user - the user making the change for audit purposes

Returns:

service config version created

Throws:

org.apache.ambari.server.AmbariException

getActiveServiceConfigVersions

public Map<String,Collection<ServiceConfigVersionResponse>> getActiveServiceConfigVersions()

Description copied from interface: Cluster

Get currently active service config versions for stack services

Specified by:

getActiveServiceConfigVersions in interface Cluster

Returns:

getServiceConfigVersions

public List<ServiceConfigVersionResponse> getServiceConfigVersions()

Description copied from interface: Cluster

Get service config version history

Specified by:

getServiceConfigVersions in interface Cluster

Returns:

getActiveServiceConfigVersionResponse

public List<ServiceConfigVersionResponse> getActiveServiceConfigVersionResponse(String serviceName)

Description copied from interface: Cluster

Get active service config version responses for all config groups of a service

Specified by:

getActiveServiceConfigVersionResponse in interface Cluster

Parameters:

serviceName - service name

Returns:

getDesiredConfigByType

public Config getDesiredConfigByType(String configType)

Description copied from interface: Cluster

Gets the desired (and selected) config by type.

Specified by:

getDesiredConfigByType in interface Cluster

Parameters:

configType - the type of configuration

Returns:

the Config instance, or null if the type has not been set.

isConfigTypeExists

public boolean isConfigTypeExists(String configType)

Description copied from interface: Cluster

Check if config type exists in cluster.

Specified by:

isConfigTypeExists in interface Cluster

Parameters:

configType - the type of configuration

Returns:

true if config type exists, else - false

getHostsDesiredConfigs

public Map<Long,Map<String,DesiredConfig>> getHostsDesiredConfigs(Collection<Long> hostIds)

Description copied from interface: Cluster

Fetch desired configs for list of hosts in cluster

Specified by:

getHostsDesiredConfigs in interface Cluster

Returns:

getAllHostsDesiredConfigs

public Map<Long,Map<String,DesiredConfig>> getAllHostsDesiredConfigs()

Description copied from interface: Cluster

Fetch desired configs for all hosts in cluster

Specified by:

getAllHostsDesiredConfigs in interface Cluster

Returns:

getNextConfigVersion

public Long getNextConfigVersion(String type)

Get next version of specified config type

Specified by:

getNextConfigVersion in interface Cluster

Parameters:

type - config type

Returns:

next version of config

processServiceComponentHostEvents

public Map<ServiceComponentHostEvent,String> processServiceComponentHostEvents(com.google.common.collect.ListMultimap<String,ServiceComponentHostEvent> eventMap)

Bulk handle service component host events

Specified by:

processServiceComponentHostEvents in interface Cluster

Parameters:

eventMap - serviceName - event mapping

Returns:

map of failed events where key is event and value is short message

processServiceComponentHostEventsInSingleTransaction

protected Map<ServiceComponentHostEvent,String> processServiceComponentHostEventsInSingleTransaction(com.google.common.collect.ListMultimap<String,ServiceComponentHostEvent> eventMap)

Bulk handle service component host events, wrapping all handling in a single transaction. This allows processServiceComponentHostEvents(ListMultimap) to lock around the AoP Transactional annotation so that the lock is not released before the transaction is committed.

Parameters:

eventMap -

Returns:

the events which failed to be processed.

getHosts

public Set<String> getHosts(String serviceName,
                            String componentName)

Description copied from interface: Cluster

Get all of the hosts running the provided service and component.

Specified by:

getHosts in interface Cluster

Parameters:

serviceName - name of the service

componentName - name of the component

Returns:

the set of hosts for the provided service and component

getHost

public Host getHost(String hostName)

Description copied from interface: Cluster

Get specific host info using host name.

Specified by:

getHost in interface Cluster

Parameters:

hostName - the host name

Returns:

Host info Host

getHost

public Host getHost(Long hostId)

Description copied from interface: Cluster

Get specific host info using host id.

Specified by:

getHost in interface Cluster

Parameters:

hostId - the host id

Returns:

Host info Host

getHosts

public Collection<Host> getHosts()

Description copied from interface: Cluster

Get all hosts associated with this cluster.

Specified by:

getHosts in interface Cluster

Returns:

collection of hosts that are associated with this cluster

checkPermission

public boolean checkPermission(PrivilegeEntity privilegeEntity,
                               boolean readOnly)

Description copied from interface: Cluster

Determine whether or not access to this cluster resource should be allowed based on the given privilege.

Specified by:

checkPermission in interface Cluster

Parameters:

privilegeEntity - the privilege

readOnly - indicate whether or not this check is for a read only operation

Returns:

true if the access to this cluster is allowed

addSessionAttributes

public void addSessionAttributes(Map<String,Object> attributes)

Description copied from interface: Cluster

Add the given map of attributes to the session for this cluster.

Specified by:

addSessionAttributes in interface Cluster

Parameters:

attributes - the session attributes

setSessionAttribute

public void setSessionAttribute(String key,
                                Object value)

Description copied from interface: Cluster

Sets or adds an attribute in the session for this cluster

Specified by:

setSessionAttribute in interface Cluster

Parameters:

key - the name of the key which identifies the attribute in the map

value - the value to set

removeSessionAttribute

public void removeSessionAttribute(String key)

Description copied from interface: Cluster

Removes an attribute from the session for this cluster

Specified by:

removeSessionAttribute in interface Cluster

Parameters:

key - the name of the key which identifies the attribute in the map

getSessionAttributes

public Map<String,Object> getSessionAttributes()

Description copied from interface: Cluster

Get the map of session attributes for this cluster.

Specified by:

getSessionAttributes in interface Cluster

Returns:

the map of session attributes for this cluster; never null

getSessionManager

protected AmbariSessionManager getSessionManager()

Get the associated session manager.

Returns:

the session manager

applyLatestConfigurations

public void applyLatestConfigurations(StackId stackId,
                                      String serviceName)

Makes the most recent configurations for the specified stack current. This will only modify configurations for the given service.

When completed, all other configurations for any other stack will remain, but will not be marked as selected.

Specified by:

applyLatestConfigurations in interface Cluster

Parameters:

stackId - the stack to use when finding the latest configurations (not null).

serviceName - the service to modify configurations for (not null).

getConfigPropertiesTypes

public Map<PropertyInfo.PropertyType,Set<String>> getConfigPropertiesTypes(String configType)

Gets all properties types that matches the specified type for the current stack.

Specified by:

getConfigPropertiesTypes in interface Cluster

Parameters:

configType - the config type to return

Returns:

properties types for given config type

getConfigPropertiesTypes

public Map<PropertyInfo.PropertyType,Set<String>> getConfigPropertiesTypes(String configType,
                                                                           StackId stackId)

Gets all properties types that matches the specified type for the given stack.

Specified by:

getConfigPropertiesTypes in interface Cluster

Parameters:

configType - the config type to return

stackId - the stack to scan properties for

Returns:

properties types for given config type

removeConfigurations

public void removeConfigurations(StackId stackId,
                                 String serviceName)

Removes all configurations for the specified service and stack.

Specified by:

removeConfigurations in interface Cluster

Parameters:

stackId - the stack to use when finding the configurations to remove (not null).

serviceName - the service to rmeove configurations for (not null).

isBluePrintDeployed

public boolean isBluePrintDeployed()

Returns whether this cluster was provisioned by a Blueprint or not.

Specified by:

isBluePrintDeployed in interface Cluster

Returns:

true if the cluster was deployed with a Blueprint otherwise false.

getClusterEntity

public ClusterEntity getClusterEntity()

Gets the ClusterEntity for this Cluster from the EntityManager cache.

Specified by:

getClusterEntity in interface Cluster

Returns:

getClusterSize

public int getClusterSize()

Returns the number of hosts that form the cluster.

Specified by:

getClusterSize in interface Cluster

Returns:

number of hosts that form the cluster

getUpgradeInProgress

public UpgradeEntity getUpgradeInProgress()

Gets an UpgradeEntity if there is an upgrade in progress or an upgrade that has been suspended. This will return the associated UpgradeEntity if it exists.

Specified by:

getUpgradeInProgress in interface Cluster

Returns:

an upgrade which will either be in progress or suspended, or null if none.

setUpgradeEntity

public void setUpgradeEntity(UpgradeEntity upgradeEntity)
                      throws org.apache.ambari.server.AmbariException

Sets or clears the associated upgrade with the cluster.

Specified by:

setUpgradeEntity in interface Cluster

Parameters:

upgradeEntity - the upgrade entity to set for cluster, or null for none.

Throws:

org.apache.ambari.server.AmbariException

isUpgradeSuspended

public boolean isUpgradeSuspended()

Gets whether there is an upgrade which has been suspended and not yet finalized.

Specified by:

isUpgradeSuspended in interface Cluster

Returns:

true if the last upgrade is suspended

getClusterProperty

public String getClusterProperty(String propertyName,
                                 String defaultValue)

Gets the most recent value of cluster-env/propertyName where propertyName is the paramter specified to the method. This will use the desired configuration for cluster-env.

The value is cached on this Cluster instance, so subsequent calls will not inclur a lookup penalty. This class also responds to ClusterConfigChangedEvent in order to clear the cache.

Specified by:

getClusterProperty in interface Cluster

Parameters:

propertyName - the property to lookup in cluster-env (not null).

defaultValue - a default value to cache return if none exists (may be null).

Returns:

handleClusterEnvConfigChangedEvent

public void handleClusterEnvConfigChangedEvent(ClusterConfigChangedEvent event)

Handles ClusterConfigChangedEvent which means that the {{cluster-env}} may have changed.

Parameters:

event - the change event.

onClusterProvisioned

public void onClusterProvisioned(ClusterProvisionedEvent event)

getRoleCommandOrder

public RoleCommandOrder getRoleCommandOrder()

Gets a new instance of a RoleCommandOrder for this cluster.

Specified by:

getRoleCommandOrder in interface Cluster

Returns:

the role command order instance (not null).

addSuspendedUpgradeParameters

public void addSuspendedUpgradeParameters(Map<String,String> commandParams,
                                          Map<String,String> roleParams)

Adds upgrade specific command and role parameters to the command maps if there is a suspended upgrade. If there is not a suspended upgrade, then the maps are not modified.

Specified by:

addSuspendedUpgradeParameters in interface Cluster

Parameters:

commandParams - the command parameter map to supplement (not null).

roleParams - the role parameter map to supplement (not null).

getComponentVersionMap

public Map<String,Map<String,String>> getComponentVersionMap()

Gets a mapping of service to component/version for every installed component in the cluster which advertises a version and for which the repository has been resolved.

Specified by:

getComponentVersionMap in interface Cluster

Returns:

a mapping of service to component version, or an empty map.

buildClusterInformation

public org.apache.ambari.spi.ClusterInformation buildClusterInformation()

Builds a ClusterInformation instance from a Cluster.

Specified by:

buildClusterInformation in interface Cluster

Returns:

the ClusterInformation instance comprised of simple POJOs and SPI classes.