org.apache.ambari.server.state.configgroup

Interface ConfigGroup

All Known Implementing Classes:

ConfigGroupImpl

public interface ConfigGroup

Configuration group or Config group is a type of Ambari resource that supports grouping of configuration resources and host resources for a service, service component or host component.

Method Summary

Modifier and Type	Method and Description
void	addHost(Host host) Add host to Config group
ConfigGroupResponse	convertToResponse() Return @ConfigGroupResponse for the config group
void	delete() Delete config group and the related host and config mapping entities from the persistence store
String	getClusterName() Cluster name to which config group belongs
Map<String,Config>	getConfigurations() Gets an unmodifiable map of Configs.
String	getDescription() Config group description
Map<Long,Host>	getHosts() Gets an unmodifiable list of Hosts.
Long	getId() Primary key of config group
String	getName() Unique config group name
String	getServiceName() Name of service which config group is wired to
String	getTag() Tag which associates config group to service
void	removeHost(Long hostId) Remove host mapping
void	setConfigurations(Map<String,Config> configs) Reassign the set of configs associated with this config group
void	setDescription(String description) Update description
void	setHosts(Map<Long,Host> hosts) Reassign the set of hosts associated with this config group
void	setName(String name) Update Group name
void	setServiceName(String serviceName)
void	setTag(String tag) Update tag

Method Detail

getId

Long getId()

Primary key of config group

Returns:

getName

String getName()

Unique config group name

Returns:

setName

void setName(String name)

Update Group name

Parameters:

name -

getClusterName

String getClusterName()

Cluster name to which config group belongs

Returns:

getTag

String getTag()

Tag which associates config group to service

Returns:

setTag

void setTag(String tag)

Update tag

Parameters:

tag -

getDescription

String getDescription()

Config group description

Returns:

setDescription

void setDescription(String description)

Update description

Parameters:

description -

getHosts

Map<Long,Host> getHosts()

Gets an unmodifiable list of Hosts.

Returns:

getConfigurations

Map<String,Config> getConfigurations()

Gets an unmodifiable map of Configs.

Returns:

delete

void delete()

Delete config group and the related host and config mapping entities from the persistence store

addHost

void addHost(Host host)
      throws org.apache.ambari.server.AmbariException

Add host to Config group

Parameters:

host -

Throws:

org.apache.ambari.server.AmbariException

convertToResponse

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

Return @ConfigGroupResponse for the config group

Returns:

@ConfigGroupResponse

Throws:

org.apache.ambari.server.AmbariException

setHosts

void setHosts(Map<Long,Host> hosts)

Reassign the set of hosts associated with this config group

Parameters:

hosts -

setConfigurations

void setConfigurations(Map<String,Config> configs)
                throws org.apache.ambari.server.AmbariException

Reassign the set of configs associated with this config group

Parameters:

configs -

Throws:

org.apache.ambari.server.AmbariException

removeHost

void removeHost(Long hostId)
         throws org.apache.ambari.server.AmbariException

Remove host mapping

Throws:

org.apache.ambari.server.AmbariException

getServiceName

String getServiceName()

Name of service which config group is wired to

setServiceName

void setServiceName(String serviceName)