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
boolean	addDesiredConfig(String user, Config config) 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) Add service to the cluster
boolean	canBeRemoved() Gets if the cluster can be deleted
ClusterResponse	convertToResponse() Creates a cluster response based on the current cluster definition
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) Delete the named service associated with this cluster
Collection<Config>	getAllConfigs() Gets all configurations defined for a cluster.
Map<String,Map<String,DesiredConfig>>	getAllHostsDesiredConfigs() Fetch desired configs for all hosts in cluster
Map<Long,RequestExecution>	getAllRequestExecutions() Get all @RequestExecution objects associated with the cluster
ReadWriteLock	getClusterGlobalLock() Get lock to control access to cluster structure
long	getClusterId() Get the cluster ID
String	getClusterName() Get the Cluster Name
Config	getConfig(String configType, String versionTag) Gets the specific config that matches the specified type and tag.
Map<Long,ConfigGroup>	getConfigGroups() Get all config groups associated with this cluster
Map<Long,ConfigGroup>	getConfigGroupsByHostname(String hostname) Find all config groups associated with the give hostname
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 desired configurations for the cluster.
StackId	getDesiredStackVersion() Get desired stack version
Map<String,Map<String,DesiredConfig>>	getHostsDesiredConfigs(Collection<String> hostnames) Fetch desired configs for list of hosts in cluster
Service	getService(String serviceName) Get a service
List<ServiceComponentHost>	getServiceComponentHosts(String hostname) Get all ServiceComponentHosts on a given host
Map<String,Service>	getServices() Get all services
void	refresh() Refreshes the cluster details
void	removeServiceComponentHost(ServiceComponentHost svcCompHost) Remove ServiceComponentHost from 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

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

addService

void addService(Service service)
         throws AmbariException

Add a service to a cluster

Parameters:

service -

Throws:

AmbariException

getService

Service getService(String serviceName)
            throws AmbariException

Get a service

Parameters:

serviceName -

Returns:

Throws:

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:

removeServiceComponentHost

void removeServiceComponentHost(ServiceComponentHost svcCompHost)
                         throws AmbariException

Remove ServiceComponentHost from cluster

Parameters:

ServiceComponentHost -

Throws:

AmbariException

getDesiredStackVersion

StackId getDesiredStackVersion()

Get desired stack version

Returns:

setDesiredStackVersion

void setDesiredStackVersion(StackId stackVersion)

Set desired stack version

Parameters:

stackVersion -

getCurrentStackVersion

StackId getCurrentStackVersion()

Get current stack version

Returns:

setCurrentStackVersion

void setCurrentStackVersion(StackId stackVersion)
                     throws AmbariException

Set current stack version

Parameters:

stackVersion -

Throws:

AmbariException

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

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

boolean addDesiredConfig(String user,
                         Config config)

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

config - the Config object to set as desired

Returns:

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

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.

getDesiredConfigs

Map<String,DesiredConfig> getDesiredConfigs()

Gets the desired configurations for the cluster.

Returns:

a map of type-to-configuration information.

convertToResponse

ClusterResponse convertToResponse()
                           throws AmbariException

Creates a cluster response based on the current cluster definition

Returns:

Throws:

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 AmbariException

Delete all the services associated with this cluster

Throws:

AmbariException

deleteService

void deleteService(String serviceName)
            throws AmbariException

Delete the named service associated with this cluster

Parameters:

serviceName -

Throws:

AmbariException

canBeRemoved

boolean canBeRemoved()

Gets if the cluster can be deleted

Returns:

delete

void delete()
     throws AmbariException

Delete the cluster

Throws:

AmbariException

addService

Service addService(String serviceName)
            throws AmbariException

Add service to the cluster

Parameters:

serviceName -

Returns:

Throws:

AmbariException

getClusterGlobalLock

ReadWriteLock getClusterGlobalLock()

Get lock to control access to cluster structure

Returns:

cluster-global lock

getHostsDesiredConfigs

Map<String,Map<String,DesiredConfig>> getHostsDesiredConfigs(Collection<String> hostnames)

Fetch desired configs for list of hosts in cluster

Parameters:

hostnames -

Returns:

getAllHostsDesiredConfigs

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

Fetch desired configs for all hosts in cluster

Returns:

addConfigGroup

void addConfigGroup(ConfigGroup configGroup)
             throws AmbariException

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

Parameters:

configGroup -

Throws:

AmbariException

getConfigGroups

Map<Long,ConfigGroup> getConfigGroups()
                               throws AmbariException

Get all config groups associated with this cluster

Returns:

Throws:

AmbariException

deleteConfigGroup

void deleteConfigGroup(Long id)
                throws AmbariException

Delete this config group identified by the config group id

Parameters:

id -

Throws:

AmbariException

getConfigGroupsByHostname

Map<Long,ConfigGroup> getConfigGroupsByHostname(String hostname)
                                         throws AmbariException

Find all config groups associated with the give hostname

Parameters:

hostname -

Returns:

Map of config group id to config group

Throws:

AmbariException

addRequestExecution

void addRequestExecution(RequestExecution requestExecution)
                  throws AmbariException

Add a @RequestExecution to the cluster

Parameters:

requestExecution -

Throws:

AmbariException

getAllRequestExecutions

Map<Long,RequestExecution> getAllRequestExecutions()

Get all @RequestExecution objects associated with the cluster

Returns:

deleteRequestExecution

void deleteRequestExecution(Long id)
                     throws AmbariException

Delete a @RequestExecution associated with the cluster

Parameters:

id -

Throws:

AmbariException