org.apache.ambari.server.controller.internal

Class Stack

java.lang.Object

org.apache.ambari.server.controller.internal.Stack

public class Stack
extends Object

Encapsulates stack information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stack.ConfigProperty Contains a configuration property's value and attributes.

Constructor Summary

Constructors

Constructor and Description
Stack(StackEntity stack, AmbariManagementController ambariManagementController) Constructor.
Stack(StackId stackId, AmbariManagementController ambariManagementController)
Stack(String name, String version, AmbariManagementController controller) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAllConfigurationTypes(String service) Get all configuration types, including excluded types for the specified service.
AutoDeployInfo	getAutoDeployInfo(String component) Obtain auto-deploy information for the specified component.
Cardinality	getCardinality(String component) Obtain the required cardinality for the specified component.
ComponentInfo	getComponentInfo(String component) Get info for the specified component.
Map<String,Collection<String>>	getComponents() Get all service components
Collection<String>	getComponents(String service) Get components contained in the stack for the specified service.
String	getConditionalServiceForDependency(DependencyInfo dependency) Get the service, if any, that a component dependency is conditional on.
Configuration	getConfiguration()
Configuration	getConfiguration(Collection<String> services)
Map<String,Map<String,String>>	getConfigurationAttributes(String service, String type) Get config attributes for the specified service and configuration type.
Map<String,String>	getConfigurationProperties(String service, String type) Get config properties for the specified service and configuration type.
Map<String,Stack.ConfigProperty>	getConfigurationPropertiesWithMetadata(String service, String type)
Collection<String>	getConfigurationTypes(String service) Get configuration types for the specified service.
Configuration	getDefaultConfig()
Collection<DependencyInfo>	getDependenciesForComponent(String component) Return the dependencies specified for the given component.
Set<String>	getExcludedConfigurationTypes(String service) Get the set of excluded configuration types for this service.
String	getExternalComponentConfig(String component)
String	getName() Obtain stack name.
Collection<Stack.ConfigProperty>	getRequiredConfigurationProperties(String service) Get all required config properties for the specified service.
Collection<Stack.ConfigProperty>	getRequiredConfigurationProperties(String service, PropertyInfo.PropertyType propertyType) Get required config properties for the specified service which belong to the specified property type.
String	getServiceForComponent(String component) Get the service for the specified component.
String	getServiceForConfigType(String config) Obtain the service name which corresponds to the specified configuration.
Optional<ServiceInfo>	getServiceInfo(String serviceName)
Set<String>	getServices() Get services contained in the stack.
Collection<String>	getServicesForComponents(Collection<String> components) Get the names of the services which contains the specified components.
List<String>	getServicesForConfigType(String config)
Map<String,Map<String,String>>	getStackConfigurationAttributes(String type)
Map<String,String>	getStackConfigurationProperties(String type)
StackId	getStackId()
Configuration	getValidDefaultConfig()
String	getVersion() Obtain stack version.
boolean	isKerberosPrincipalNameProperty(String service, String type, String propertyName)
boolean	isMasterComponent(String component)
boolean	isPasswordProperty(String service, String type, String propertyName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Stack

public Stack(StackEntity stack,
             AmbariManagementController ambariManagementController)
      throws org.apache.ambari.server.AmbariException

Constructor.

Parameters:

stack - the stack (not null).

ambariManagementController - the management controller (not null).

Throws:

org.apache.ambari.server.AmbariException

Stack

public Stack(StackId stackId,
             AmbariManagementController ambariManagementController)
      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

Stack

public Stack(String name,
             String version,
             AmbariManagementController controller)
      throws org.apache.ambari.server.AmbariException

Constructor.

Parameters:

name - stack name

version - stack version

Throws:

org.apache.ambari.server.AmbariException - an exception occurred getting stack information for the specified name and version

Method Detail

getName

public String getName()

Obtain stack name.

Returns:

stack name

getVersion

public String getVersion()

Obtain stack version.

Returns:

stack version

getStackId

public StackId getStackId()

toString

public String toString()

Overrides:

toString in class Object

getServices

public Set<String> getServices()

Get services contained in the stack.

Returns:

set of all services for the stack

getComponents

public Collection<String> getComponents(String service)

Get components contained in the stack for the specified service.

Parameters:

service - service name

Returns:

collection of component names for the specified service

getComponents

public Map<String,Collection<String>> getComponents()

Get all service components

Returns:

map of service to associated components

getComponentInfo

public ComponentInfo getComponentInfo(String component)

Get info for the specified component.

Parameters:

component - component name

Returns:

component information for the requested component or null if the component doesn't exist in the stack

getServiceInfo

public Optional<ServiceInfo> getServiceInfo(String serviceName)

Returns:

an optional ServiceInfo of the given serviceName or Optional.empty() if the service doesn't exist in the stack

getAllConfigurationTypes

public Collection<String> getAllConfigurationTypes(String service)

Get all configuration types, including excluded types for the specified service.

Parameters:

service - service name

Returns:

collection of all configuration types for the specified service

getConfigurationTypes

public Collection<String> getConfigurationTypes(String service)

Get configuration types for the specified service. This doesn't include any service excluded types.

Parameters:

service - service name

Returns:

collection of all configuration types for the specified service

getExcludedConfigurationTypes

public Set<String> getExcludedConfigurationTypes(String service)

Get the set of excluded configuration types for this service.

Parameters:

service - service name

Returns:

Set of names of excluded config types. Will not return null.

getConfigurationProperties

public Map<String,String> getConfigurationProperties(String service,
                                                     String type)

Get config properties for the specified service and configuration type.

Parameters:

service - service name

type - configuration type

Returns:

map of property names to values for the specified service and configuration type

getConfigurationPropertiesWithMetadata

public Map<String,Stack.ConfigProperty> getConfigurationPropertiesWithMetadata(String service,
                                                                               String type)

getRequiredConfigurationProperties

public Collection<Stack.ConfigProperty> getRequiredConfigurationProperties(String service)

Get all required config properties for the specified service.

Parameters:

service - service name

Returns:

collection of all required properties for the given service

getRequiredConfigurationProperties

public Collection<Stack.ConfigProperty> getRequiredConfigurationProperties(String service,
                                                                           PropertyInfo.PropertyType propertyType)

Get required config properties for the specified service which belong to the specified property type.

Parameters:

service - service name

propertyType - property type

Returns:

collection of required properties for the given service and property type

isPasswordProperty

public boolean isPasswordProperty(String service,
                                  String type,
                                  String propertyName)

getStackConfigurationProperties

public Map<String,String> getStackConfigurationProperties(String type)

isKerberosPrincipalNameProperty

public boolean isKerberosPrincipalNameProperty(String service,
                                               String type,
                                               String propertyName)

getConfigurationAttributes

public Map<String,Map<String,String>> getConfigurationAttributes(String service,
                                                                 String type)

Get config attributes for the specified service and configuration type.

Parameters:

service - service name

type - configuration type

Returns:

map of attribute names to map of property names to attribute values for the specified service and configuration type

getStackConfigurationAttributes

public Map<String,Map<String,String>> getStackConfigurationAttributes(String type)

getServiceForComponent

public String getServiceForComponent(String component)

Get the service for the specified component.

Parameters:

component - component name

Returns:

service name that contains tha specified component

getServicesForComponents

public Collection<String> getServicesForComponents(Collection<String> components)

Get the names of the services which contains the specified components.

Parameters:

components - collection of components

Returns:

collection of services which contain the specified components

getServiceForConfigType

public String getServiceForConfigType(String config)

Obtain the service name which corresponds to the specified configuration.

Parameters:

config - configuration type

Returns:

name of service which corresponds to the specified configuration type

getServicesForConfigType

public List<String> getServicesForConfigType(String config)

getDependenciesForComponent

public Collection<DependencyInfo> getDependenciesForComponent(String component)

Return the dependencies specified for the given component.

Parameters:

component - component to get dependency information for

Returns:

collection of dependency information for the specified component

getConditionalServiceForDependency

public String getConditionalServiceForDependency(DependencyInfo dependency)

Get the service, if any, that a component dependency is conditional on.

Parameters:

dependency - dependency to get conditional service for

Returns:

conditional service for provided component or null if dependency is not conditional on a service

getExternalComponentConfig

public String getExternalComponentConfig(String component)

getCardinality

public Cardinality getCardinality(String component)

Obtain the required cardinality for the specified component.

getAutoDeployInfo

public AutoDeployInfo getAutoDeployInfo(String component)

Obtain auto-deploy information for the specified component.

isMasterComponent

public boolean isMasterComponent(String component)

getConfiguration

public Configuration getConfiguration(Collection<String> services)

getConfiguration

public Configuration getConfiguration()

getValidDefaultConfig

public Configuration getValidDefaultConfig()

Returns:

default configuration of the stack, with some updates necessary so that the config can be applied (eg. some properties need a unit to be appended)

getDefaultConfig

public Configuration getDefaultConfig()