org.apache.ambari.server.state

Interface Cluster

All Known Implementing Classes:

ClusterImpl

public interface Cluster

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	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()
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.
default Set<String>	getHostNames()
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.
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.
UpgradeEntity	getUpgradeInProgress() Gets an UpgradeEntity if there is an upgrade in progress or an upgrade that has been suspended.
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.
Map<ServiceComponentHostEvent,String>	processServiceComponentHostEvents(com.google.common.collect.ListMultimap<String,ServiceComponentHostEvent> eventMap) Bulk handle service component host events
void	refresh() Refreshes the cluster details
void	removeConfigurations(StackId stackId, String serviceName) Removes all configurations for the specified service and stack.
void	removeServiceComponentHost(ServiceComponentHost svcCompHost) Remove ServiceComponentHost from cluster
void	removeSessionAttribute(String key) Removes an attribute from the session for this cluster
void	setClusterName(String clusterName) Set the Cluster Name
void	setCurrentStackVersion(StackId stackVersion) Set current stack version
void	setDesiredStackVersion(StackId stackVersion) 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.

Method Detail

getClusterId

long getClusterId()

Get the cluster ID

getClusterName

String getClusterName()

Get the Cluster Name

setClusterName

void setClusterName(String clusterName)

Set the Cluster Name

getResourceId

Long getResourceId()

Gets the Cluster's resource ID

addService

void addService(Service service)

Add a service to a cluster

Parameters:

service -

getService

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

Get a service

Parameters:

serviceName -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getServiceByComponentName

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

Gets a service from the given component name.

Parameters:

componentName -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getServices

Map<String,Service> getServices()

Get all services

Returns:

getServiceComponentHosts

List<ServiceComponentHost> getServiceComponentHosts(String hostname)

Get all ServiceComponentHosts on a given host

Parameters:

hostname -

Returns:

getServiceComponentHostMap

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

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

Parameters:

hostNames -

serviceNames -

Returns:

a map of (filtered) components to hosts

getServiceComponentHosts

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.

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

getServiceComponentHosts

List<ServiceComponentHost> getServiceComponentHosts()

Get all ServiceComponentHosts for this cluster.

getHosts

Collection<Host> getHosts()

Get all hosts associated with this cluster.

Returns:

collection of hosts that are associated with this cluster

getHostNames

default Set<String> getHostNames()

getHosts

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

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

Parameters:

serviceName -

componentName -

Returns:

getHost

Host getHost(String hostName)

Get specific host info using host name.

Parameters:

hostName - the host name

Returns:

Host info Host

getHost

Host getHost(Long hostId)

Get specific host info using host id.

Parameters:

hostId - the host id

Returns:

Host info Host

addServiceComponentHosts

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

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

Parameters:

serviceComponentHosts -

Throws:

org.apache.ambari.server.AmbariException

removeServiceComponentHost

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

Remove ServiceComponentHost from cluster

Parameters:

svcCompHost -

Throws:

org.apache.ambari.server.AmbariException

getDesiredStackVersion

StackId getDesiredStackVersion()

Get desired stack version

Returns:

setDesiredStackVersion

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

Set desired stack version

Parameters:

stackVersion -

Throws:

org.apache.ambari.server.AmbariException

getCurrentStackVersion

StackId getCurrentStackVersion()

Get current stack version

Returns:

setCurrentStackVersion

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

Set current stack version

Parameters:

stackVersion -

Throws:

org.apache.ambari.server.AmbariException

transitionHostsToInstalling

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.

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

getProvisioningState

State getProvisioningState()

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

Returns:

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

setProvisioningState

void setProvisioningState(State provisioningState)

Sets the provisioning state of the cluster.

Parameters:

provisioningState - the provisioning state, not null.

getSecurityType

SecurityType getSecurityType()

Gets the cluster's security type.

Returns:

this Cluster's security type

setSecurityType

void setSecurityType(SecurityType securityType)

Sets this Cluster's security type.

Parameters:

securityType - a SecurityType to set

getConfigsByType

Map<String,Config> getConfigsByType(String configType)

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

Parameters:

configType - the config type to return

Returns:

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

getConfigPropertiesTypes

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

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

Parameters:

configType - the config type to return

Returns:

properties types for given config type

getConfigPropertiesTypes

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

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

Parameters:

configType - the config type to return

stackId - the stack to scan properties for

Returns:

properties types for given config type

getConfig

Config getConfig(String configType,
                 String versionTag)

Gets the specific config that matches the specified type and tag. This not necessarily a DESIRED configuration that applies to a 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

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

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

Returns:

the list of configurations with the given types

getConfigByVersion

Config getConfigByVersion(String configType,
                          Long configVersion)

Gets the specific config that matches the specified type and version. This not necessarily a DESIRED configuration that applies to a 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

void addConfig(Config config)

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

Parameters:

config - the config instance to add

getAllConfigs

Collection<Config> getAllConfigs()

Gets all configurations defined for a cluster.

Returns:

the collection of all configs that have been defined.

addDesiredConfig

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

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

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

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

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

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

createServiceConfigVersion

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

Throws:

org.apache.ambari.server.AmbariException

getServiceForConfigTypes

String getServiceForConfigTypes(Collection<String> configTypes)

setServiceConfigVersion

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

Apply specified service config version (rollback)

Parameters:

serviceName - service name

version - service config version

user - the user making the change for audit purposes

note -

Returns:

service config version created

Throws:

org.apache.ambari.server.AmbariException

getActiveServiceConfigVersions

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

Get currently active service config versions for stack services

Returns:

getActiveServiceConfigVersionResponse

List<ServiceConfigVersionResponse> getActiveServiceConfigVersionResponse(String serviceName)

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

Parameters:

serviceName - service name

Returns:

getServiceConfigVersions

List<ServiceConfigVersionResponse> getServiceConfigVersions()

Get service config version history

Returns:

getDesiredConfigByType

Config getDesiredConfigByType(String configType)

Gets the desired (and selected) config by type.

Parameters:

configType - the type of configuration

Returns:

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

isConfigTypeExists

boolean isConfigTypeExists(String configType)

Check if config type exists in cluster.

Parameters:

configType - the type of configuration

Returns:

true if config type exists, else - false

getDesiredConfigs

Map<String,DesiredConfig> getDesiredConfigs()

Gets the active desired configurations for the cluster.

Returns:

a map of type-to-configuration information.

getDesiredConfigs

Map<String,DesiredConfig> getDesiredConfigs(boolean cachedConfigEntities)

Gets the active desired configurations for the 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.

getClusterEntity

ClusterEntity getClusterEntity()

getAllDesiredConfigVersions

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

Gets all versions of the desired configurations for the cluster.

Returns:

a map of type-to-configuration information.

convertToResponse

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

Creates a cluster response based on the current cluster definition

Returns:

Throws:

org.apache.ambari.server.AmbariException

refresh

void refresh()

Refreshes the cluster details

debugDump

void debugDump(StringBuilder sb)

Creates a debug dump based on the current cluster state

Parameters:

sb -

deleteAllServices

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

Delete all the services associated with this cluster

Throws:

org.apache.ambari.server.AmbariException

deleteService

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

Delete the named service associated with this cluster

Parameters:

serviceName -

Throws:

org.apache.ambari.server.AmbariException

canBeRemoved

boolean canBeRemoved()

Gets if the cluster can be deleted

Returns:

delete

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

Delete the cluster

Throws:

org.apache.ambari.server.AmbariException

addService

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

Add service to the 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

getHostsDesiredConfigs

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

Fetch desired configs for list of hosts in cluster

Parameters:

hostIds -

Returns:

getAllHostsDesiredConfigs

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

Fetch desired configs for all hosts in cluster

Returns:

addConfigGroup

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

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

Parameters:

configGroup -

Throws:

org.apache.ambari.server.AmbariException

getConfigGroups

Map<Long,ConfigGroup> getConfigGroups()

Get config groups associated with this cluster

Returns:

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

deleteConfigGroup

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

Delete this config group identified by the config group id

Parameters:

id -

Throws:

org.apache.ambari.server.AmbariException

getConfigGroupsByHostname

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

Find all config groups associated with the give hostname

Parameters:

hostname -

Returns:

Map of config group id to config group

Throws:

org.apache.ambari.server.AmbariException

getConfigGroupsById

ConfigGroup getConfigGroupsById(Long configId)

Find config group by config group id

Parameters:

configId - id of config group to return

Returns:

config group

getConfigGroupsByServiceName

Map<Long,ConfigGroup> getConfigGroupsByServiceName(String serviceName)

Find all config groups associated with the give service name

Parameters:

serviceName -

Returns:

Map of config group id to config group

addRequestExecution

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

Add a @RequestExecution to the cluster

Parameters:

requestExecution -

Throws:

org.apache.ambari.server.AmbariException

getAllRequestExecutions

Map<Long,RequestExecution> getAllRequestExecutions()

Get all @RequestExecution objects associated with the cluster

Returns:

deleteRequestExecution

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

Delete a @RequestExecution associated with the cluster

Parameters:

id -

Throws:

org.apache.ambari.server.AmbariException

getNextConfigVersion

Long getNextConfigVersion(String type)

Get next version of specified config type

Parameters:

type - config type

Returns:

next version of config

processServiceComponentHostEvents

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

Bulk handle service component host events

Parameters:

eventMap - serviceName - event mapping

Returns:

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

checkPermission

boolean checkPermission(PrivilegeEntity privilegeEntity,
                        boolean readOnly)

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

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

void addSessionAttributes(Map<String,Object> attributes)

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

Parameters:

attributes - the session attributes

setSessionAttribute

void setSessionAttribute(String key,
                         Object value)

Sets or adds an attribute in the session for this cluster

Parameters:

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

value - the value to set

removeSessionAttribute

void removeSessionAttribute(String key)

Removes an attribute from the session for this cluster

Parameters:

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

getSessionAttributes

Map<String,Object> getSessionAttributes()

Get the map of session attributes for this cluster.

Returns:

the map of session attributes for this cluster; never null

applyLatestConfigurations

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.

Parameters:

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

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

removeConfigurations

void removeConfigurations(StackId stackId,
                          String serviceName)

Removes all configurations for the specified service and stack.

Parameters:

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

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

isBluePrintDeployed

boolean isBluePrintDeployed()

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

Returns:

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

getUpgradeInProgress

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.

Returns:

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

setUpgradeEntity

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

Sets or clears the associated upgrade with the cluster.

Parameters:

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

Throws:

org.apache.ambari.server.AmbariException

isUpgradeSuspended

boolean isUpgradeSuspended()

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

Returns:

true if the last upgrade is suspended

getServiceByConfigType

String getServiceByConfigType(String configType)

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

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.

getClusterProperty

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.

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:

getClusterSize

int getClusterSize()

Returns the number of hosts that form the cluster.

Returns:

number of hosts that form the cluster

getRoleCommandOrder

RoleCommandOrder getRoleCommandOrder()

Gets a new instance of a RoleCommandOrder for this cluster.

Returns:

the role command order instance (not null).

addSuspendedUpgradeParameters

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.

Parameters:

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

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

getComponentVersionMap

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.

Returns:

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

buildClusterInformation

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

Builds a ClusterInformation instance from a Cluster.

Returns:

the ClusterInformation instance comprised of simple POJOs and SPI classes.