org.apache.ambari.server.topology

Interface HostGroup

All Known Implementing Classes:

HostGroupImpl

public interface HostGroup

Host Group representation.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	HOSTGROUP_REGEX Compiled regex for hostgroup token.

Method Summary

Modifier and Type	Method and Description
boolean	addComponent(String component) Add a component to the host group.
boolean	addComponent(String component, ProvisionAction provisionAction) Add a component to the host group, with the specified name and provision action.
boolean	containsMasterComponent() Determine if the host group contains a master component.
String	getBlueprintName() Get the name of the associated blueprint
String	getCardinality() Get the cardinality value that was specified for the host group.
Collection<String>	getComponentNames() Get all of the host group component names
Collection<String>	getComponentNames(ProvisionAction provisionAction) Get all host group component names for instances that have the specified provision action association.
Collection<Component>	getComponents() Get all of the host group components.
Collection<String>	getComponents(String service) Get the host group components which belong to the specified service.
Configuration	getConfiguration() Get the configuration associated with the host group.
String	getFullyQualifiedName() Get the fully qualified host group name in the form of blueprintName:hostgroupName
String	getName() Get the name of the host group.
Collection<String>	getServices() Get all of the services associated with the host group components.
Stack	getStack() Get the stack associated with the host group.

Field Detail

HOSTGROUP_REGEX

static final Pattern HOSTGROUP_REGEX

Compiled regex for hostgroup token.

Method Detail

getName

String getName()

Get the name of the host group.

Returns:

the host group name

getBlueprintName

String getBlueprintName()

Get the name of the associated blueprint

Returns:

associated blueprint name

getFullyQualifiedName

String getFullyQualifiedName()

Get the fully qualified host group name in the form of blueprintName:hostgroupName

Returns:

fully qualified host group name

getComponents

Collection<Component> getComponents()

Get all of the host group components.

Returns:

collection of component instances

getComponentNames

Collection<String> getComponentNames()

Get all of the host group component names

Returns:

collection of component names as String

getComponentNames

Collection<String> getComponentNames(ProvisionAction provisionAction)

Get all host group component names for instances that have the specified provision action association.

Parameters:

provisionAction - the provision action that must be associated with the component names returned

Returns:

collection of component names as String that are associated with the specified provision action

getComponents

Collection<String> getComponents(String service)

Get the host group components which belong to the specified service.

Parameters:

service - service name

Returns:

collection of component names for the specified service; will not return null

addComponent

boolean addComponent(String component)

Add a component to the host group.

Parameters:

component - name of the component to add

Returns:

true if the component didn't already exist

addComponent

boolean addComponent(String component,
                     ProvisionAction provisionAction)

Add a component to the host group, with the specified name and provision action.

Parameters:

component - component name

provisionAction - provision action for this component

Returns:

containsMasterComponent

boolean containsMasterComponent()

Determine if the host group contains a master component.

Returns:

true if the host group contains a master component; false otherwise

getServices

Collection<String> getServices()

Get all of the services associated with the host group components.

Returns:

collection of service names

getConfiguration

Configuration getConfiguration()

Get the configuration associated with the host group. The host group configuration has the blueprint cluster scoped configuration set as it's parent.

Returns:

host group configuration

getStack

Stack getStack()

Get the stack associated with the host group.

Returns:

associated stack

getCardinality

String getCardinality()

Get the cardinality value that was specified for the host group. This is simply meta-data for the stack that a deployer can use and this information is not used by ambari.

Returns:

the cardinality specified for the hostgroup