org.apache.ambari.server.topology

Class BlueprintImpl

java.lang.Object

org.apache.ambari.server.topology.BlueprintImpl

All Implemented Interfaces:

Blueprint

public class BlueprintImpl
extends Object
implements Blueprint

Blueprint implementation.

Constructor Summary

Constructors

Constructor and Description
BlueprintImpl(BlueprintEntity entity)
BlueprintImpl(String name, Collection<HostGroup> groups, Stack stack, Configuration configuration, SecurityConfiguration security)
BlueprintImpl(String name, Collection<HostGroup> groups, Stack stack, Configuration configuration, SecurityConfiguration security, Setting setting)

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 the specified 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 host groups which contain a component.
Collection<HostGroup>	getHostGroupsForService(String service) Get host groups which contain a component for the given service.
String	getName() Get the name of the blueprint.
String	getRecoveryEnabled(String serviceName, String componentName) Get whether the specified component in the service is enabled for auto start.
List<RepositorySetting>	getRepositorySettings()
SecurityConfiguration	getSecurity()
Collection<ServiceInfo>	getServiceInfos()
Collection<String>	getServices() Get all services represented in blueprint.
Setting	getSetting() Get the Blueprint cluster scoped setting.
Stack	getStack() Get the stack associated with the blueprint.
String	getStackName()
String	getStackVersion()
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 blueprint configuration.
void	validateTopology() Validate the blueprint topology.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlueprintImpl

public BlueprintImpl(BlueprintEntity entity)
              throws NoSuchStackException

Throws:

NoSuchStackException

BlueprintImpl

public BlueprintImpl(String name,
                     Collection<HostGroup> groups,
                     Stack stack,
                     Configuration configuration,
                     SecurityConfiguration security)

BlueprintImpl

public BlueprintImpl(String name,
                     Collection<HostGroup> groups,
                     Stack stack,
                     Configuration configuration,
                     SecurityConfiguration security,
                     Setting setting)

Method Detail

getName

public String getName()

Description copied from interface: Blueprint

Get the name of the blueprint.

Specified by:

getName in interface Blueprint

Returns:

blueprint name

getStackName

public String getStackName()

getStackVersion

public String getStackVersion()

getSecurity

public SecurityConfiguration getSecurity()

Specified by:

getSecurity in interface Blueprint

getHostGroups

public Map<String,HostGroup> getHostGroups()

Description copied from interface: Blueprint

Get the hot groups contained in the blueprint.

Specified by:

getHostGroups in interface Blueprint

Returns:

map of host group name to host group

getHostGroup

public HostGroup getHostGroup(String name)

Description copied from interface: Blueprint

Get a hostgroup specified by name.

Specified by:

getHostGroup in interface Blueprint

Parameters:

name - name of the host group to get

Returns:

the host group with the given name or null

getConfiguration

public Configuration getConfiguration()

Description copied from interface: Blueprint

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.

Specified by:

getConfiguration in interface Blueprint

Returns:

blueprint cluster scoped configuration

getSetting

public Setting getSetting()

Description copied from interface: Blueprint

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

Specified by:

getSetting in interface Blueprint

Returns:

blueprint cluster scoped setting

getServices

public Collection<String> getServices()

Get all services represented in blueprint.

Specified by:

getServices in interface Blueprint

Returns:

collections of all services provided by topology

getServiceInfos

public Collection<ServiceInfo> getServiceInfos()

Specified by:

getServiceInfos in interface Blueprint

Returns:

collection of all service infos

getComponents

public Collection<String> getComponents(String service)

Description copied from interface: Blueprint

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

Specified by:

getComponents in interface Blueprint

Parameters:

service - service name

Returns:

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

getRecoveryEnabled

public String getRecoveryEnabled(String serviceName,
                                 String componentName)

Get whether the specified component in the service is enabled for auto start.

Specified by:

getRecoveryEnabled in interface Blueprint

Parameters:

serviceName - - Service name.

componentName - - Component name.

Returns:

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

getCredentialStoreEnabled

public String getCredentialStoreEnabled(String serviceName)

Get whether the specified service is enabled for credential store use.

     
       {
         "service_settings" : [
         { "name" : "RANGER",
           "recovery_enabled" : "true",
           "credential_store_enabled" : "true"
         },
         { "name" : "HIVE",
           "recovery_enabled" : "true",
           "credential_store_enabled" : "false"
         },
         { "name" : "TEZ",
           "recovery_enabled" : "false"
         }
       ]
     }
   
 

Specified by:

getCredentialStoreEnabled in interface Blueprint

Parameters:

serviceName - - Service name.

Returns:

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

shouldSkipFailure

public boolean shouldSkipFailure()

Description copied from interface: Blueprint

Check if auto skip failure is enabled.

Specified by:

shouldSkipFailure in interface Blueprint

Returns:

true if enabled, otherwise false.

getStack

public Stack getStack()

Description copied from interface: Blueprint

Get the stack associated with the blueprint.

Specified by:

getStack in interface Blueprint

Returns:

associated stack

getHostGroupsForComponent

public Collection<HostGroup> getHostGroupsForComponent(String component)

Get host groups which contain a component.

Specified by:

getHostGroupsForComponent in interface Blueprint

Parameters:

component - component name

Returns:

collection of host groups which contain the specified component

getHostGroupsForService

public Collection<HostGroup> getHostGroupsForService(String service)

Get host groups which contain a component for the given service.

Specified by:

getHostGroupsForService in interface Blueprint

Parameters:

service - service name

Returns:

collection of host groups which contain a component of the specified service

validateTopology

public void validateTopology()
                      throws InvalidTopologyException

Description copied from interface: Blueprint

Validate the blueprint topology.

Specified by:

validateTopology in interface Blueprint

Throws:

InvalidTopologyException - if the topology is invalid

toEntity

public BlueprintEntity toEntity()

Description copied from interface: Blueprint

Obtain the blueprint as an entity.

Specified by:

toEntity in interface Blueprint

Returns:

entity representation of the blueprint

validateRequiredProperties

public void validateRequiredProperties()
                                throws InvalidTopologyException,
                                       GPLLicenseNotAcceptedException

Validate blueprint configuration.

Specified by:

validateRequiredProperties in interface Blueprint

Throws:

InvalidTopologyException - if the blueprint configuration is invalid

GPLLicenseNotAcceptedException - ambari was configured to use gpl software, but gpl license is not accepted

isValidConfigType

public boolean isValidConfigType(String configType)

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

Specified by:

isValidConfigType in interface Blueprint

Returns:

getRepositorySettings

public List<RepositorySetting> getRepositorySettings()

Specified by:

getRepositorySettings in interface Blueprint