org.apache.ambari.server.topology

Interface Blueprint

All Known Implementing Classes:

BlueprintImpl

public interface Blueprint

Blueprint representation.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getComponents(String service) Get the components that are included in the blueprint for the specified service.
Configuration	getConfiguration() Get the Blueprint cluster scoped configuration.
String	getCredentialStoreEnabled(String serviceName) Get whether a service is enabled for credential store use.
HostGroup	getHostGroup(String name) Get a hostgroup specified by name.
Map<String,HostGroup>	getHostGroups() Get the hot groups contained in the blueprint.
Collection<HostGroup>	getHostGroupsForComponent(String component) Get the host groups which contain the give component.
Collection<HostGroup>	getHostGroupsForService(String service) Get the host groups which contain components for the specified service.
String	getName() Get the name of the blueprint.
String	getRecoveryEnabled(String serviceName, String componentName) Get whether a component is enabled for auto start.
List<RepositorySetting>	getRepositorySettings()
SecurityConfiguration	getSecurity()
Collection<ServiceInfo>	getServiceInfos()
Collection<String>	getServices() Get all of the services represented in the blueprint.
Setting	getSetting() Get the Blueprint cluster scoped setting.
Stack	getStack() Get the stack associated with the blueprint.
boolean	isValidConfigType(String configType) A config type is valid if there are services related to except cluster-env and global.
boolean	shouldSkipFailure() Check if auto skip failure is enabled.
BlueprintEntity	toEntity() Obtain the blueprint as an entity.
void	validateRequiredProperties() Validate that the blueprint contains all of the required properties.
void	validateTopology() Validate the blueprint topology.

Method Detail

getName

String getName()

Get the name of the blueprint.

Returns:

blueprint name

getHostGroups

Map<String,HostGroup> getHostGroups()

Get the hot groups contained in the blueprint.

Returns:

map of host group name to host group

getHostGroup

HostGroup getHostGroup(String name)

Get a hostgroup specified by name.

Parameters:

name - name of the host group to get

Returns:

the host group with the given name or null

getConfiguration

Configuration getConfiguration()

Get the Blueprint cluster scoped configuration. The blueprint cluster scoped configuration has the stack configuration with the config types associated with the blueprint set as it's parent.

Returns:

blueprint cluster scoped configuration

getSetting

Setting getSetting()

Get the Blueprint cluster scoped setting. The blueprint cluster scoped setting has the setting properties with the setting names associated with the blueprint.

Returns:

blueprint cluster scoped setting

getServices

Collection<String> getServices()

Get all of the services represented in the blueprint.

Returns:

collection of all represented service names

getServiceInfos

Collection<ServiceInfo> getServiceInfos()

Returns:

collection of all service infos

getComponents

Collection<String> getComponents(String service)

Get the components that are included in the blueprint for the specified service.

Parameters:

service - service name

Returns:

collection of component names for the service. Will not return null.

getRecoveryEnabled

String getRecoveryEnabled(String serviceName,
                          String componentName)

Get whether a component is enabled for auto start.

Parameters:

serviceName - - Service name.

componentName - - Component name.

Returns:

null if value is not specified; true or false if specified.

getCredentialStoreEnabled

String getCredentialStoreEnabled(String serviceName)

Get whether a service is enabled for credential store use.

Parameters:

serviceName - - Service name.

Returns:

null if value is not specified; true or false if specified.

shouldSkipFailure

boolean shouldSkipFailure()

Check if auto skip failure is enabled.

Returns:

true if enabled, otherwise false.

getStack

Stack getStack()

Get the stack associated with the blueprint.

Returns:

associated stack

getHostGroupsForService

Collection<HostGroup> getHostGroupsForService(String service)

Get the host groups which contain components for the specified service.

Parameters:

service - service name

Returns:

collection of host groups containing components for the specified service; will not return null

getHostGroupsForComponent

Collection<HostGroup> getHostGroupsForComponent(String component)

Get the host groups which contain the give component.

Parameters:

component - component name

Returns:

collection of host groups containing the specified component; will not return null

getSecurity

SecurityConfiguration getSecurity()

validateTopology

void validateTopology()
               throws InvalidTopologyException

Validate the blueprint topology.

Throws:

InvalidTopologyException - if the topology is invalid

validateRequiredProperties

void validateRequiredProperties()
                         throws InvalidTopologyException,
                                GPLLicenseNotAcceptedException

Validate that the blueprint contains all of the required properties.

Throws:

InvalidTopologyException - if the blueprint doesn't contain all required properties

GPLLicenseNotAcceptedException

isValidConfigType

boolean isValidConfigType(String configType)

A config type is valid if there are services related to except cluster-env and global.

Parameters:

configType -

Returns:

toEntity

BlueprintEntity toEntity()

Obtain the blueprint as an entity.

Returns:

entity representation of the blueprint

getRepositorySettings

List<RepositorySetting> getRepositorySettings()