StackInfo (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.state.StackInfo

All Implemented Interfaces:: Comparable<StackInfo>, Validable

public class StackInfo
extends Object
implements Comparable<StackInfo>, Validable

Constructor Summary

Constructors
Constructor and Description

StackInfo()

Constructors
Constructor and Description
`StackInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addError(String error)`
`void`	`addErrors(Collection<String> errors)`
`void`	`addExtension(ExtensionInfo extension)`
`void`	`addVersionDefinition(String key, VersionDefinitionXml xml)`
`int`	`compareTo(StackInfo o)`
`StackVersionResponse`	`convertToResponse()`
`boolean`	`equals(Object obj)`
`Map<PropertyInfo.PropertyType,Set<String>>`	`getConfigPropertiesTypes(String configType)`
`Map<String,Map<String,Map<String,String>>>`	`getConfigTypeAttributes()` Obtain the config types associated with this stack.
`ConfigUpgradePack`	`getConfigUpgradePack()` Get config upgrade pack for stack
`Map<String,Map<String,String>>`	`getDefaultConfigAttributesForConfigType(String configType)` Return default config attributes for specified config type.
`Collection<String>`	`getErrors()`
`ExtensionInfo`	`getExtension(String name)`
`ExtensionInfo`	`getExtensionByService(String serviceName)`
`Collection<ExtensionInfo>`	`getExtensions()`
`String`	`getKerberosDescriptorPreConfigurationFileLocation()` Gets the path to the stack-level Kerberos descriptor pre-configuration file
`VersionDefinitionXml`	`getLatestVersionDefinition()`
`URLClassLoader`	`getLibraryClassLoader()` Gets the `ClassLoader` that can be used to load classes found in JARs in the stack's library folder.
`<T> T`	`getLibraryInstance(com.google.inject.Injector injector, String className)` Loads an instance of the class from the stack classloader, if available.
`<T> T`	`getLibraryInstance(String className)` Loads an instance of the class from the stack classloader, if available.
`String`	`getMaxJdk()`
`String`	`getMinJdk()`
`String`	`getName()`
`String`	`getParentStackVersion()`
`List<PropertyInfo>`	`getProperties()`
`String`	`getRcoFileLocation()`
`RefreshCommandConfiguration`	`getRefreshCommandConfiguration()`
`org.apache.ambari.spi.stack.StackReleaseVersion`	`getReleaseVersion()` Gets the instance of the `StackReleaseVersion`.
`List<String>`	`getRemovedServices()`
`List<RepositoryInfo>`	`getRepositories()`
`com.google.common.collect.ListMultimap<String,RepositoryInfo>`	`getRepositoriesByOs()`
`RepositoryXml`	`getRepositoryXml()`
`Map<String,PropertyInfo>`	`getRequiredProperties()`
`StackRoleCommandOrder`	`getRoleCommandOrder()`
`ServiceInfo`	`getService(String name)`
`Set<String>`	`getServiceNames()`
`Collection<ServiceInfo>`	`getServices()`
`List<String>`	`getServicesWithNoConfigs()`
`Map<String,UpgradePack>`	`getUpgradePacks()` Obtain all stack upgrade packs.
`String`	`getUpgradesFolder()` Obtain the path of the upgrades folder or null if directory doesn't exist.
`String`	`getVersion()`
`Collection<VersionDefinitionXml>`	`getVersionDefinitions()`
`int`	`hashCode()`
`boolean`	`isActive()`
`boolean`	`isValid()`
`void`	`removeExtension(ExtensionInfo extension)`
`void`	`setActive(boolean active)`
`void`	`setAllConfigAttributes(Map<String,Map<String,Map<String,String>>> types)` Set all types and associated attributes.
`void`	`setConfigTypeAttributes(String type, Map<String,Map<String,String>> typeAttributes)` Add the given type and set it's attributes.
`void`	`setConfigUpgradePack(ConfigUpgradePack configUpgradePack)` Set config upgrade pack for stack
`void`	`setKerberosDescriptorPreConfigurationFileLocation(String kerberosDescriptorPreConfigurationFileLocation)` Sets the path to the stack-level Kerberos descriptor file
`void`	`setLatestVersionDefinition(VersionDefinitionXml xml)`
`void`	`setLibraryClassLoader(URLClassLoader libraryClassLoader)` Sets the `ClassLoader` that can be used to load classes found in JARs in the stack's library folder.
`void`	`setMaxJdk(String maxJdk)`
`void`	`setMinJdk(String minJdk)`
`void`	`setName(String name)`
`void`	`setParentStackVersion(String parentStackVersion)`
`void`	`setProperties(List<PropertyInfo> properties)`
`void`	`setRcoFileLocation(String rcoFileLocation)`
`void`	`setRefreshCommandConfiguration(RefreshCommandConfiguration refreshCommandConfiguration)`
`void`	`setReleaseVersionClass(String className)`
`void`	`setRemovedServices(List<String> removedServices)`
`void`	`setRepositoryXml(RepositoryXml rxml)`
`void`	`setRoleCommandOrder(StackRoleCommandOrder roleCommandOrder)`
`void`	`setServices(Collection<ServiceInfo> services)`
`void`	`setServicesWithNoConfigs(List<String> servicesWithNoConfigs)`
`void`	`setUpgradePacks(Map<String,UpgradePack> upgradePacks)` Set upgrade packs.
`void`	`setUpgradesFolder(String path)` Set the path of the stack upgrade directory.
`void`	`setValid(boolean valid)`
`void`	`setVersion(String version)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StackInfo
```
public StackInfo()
```
- Method Detail
  - getMinJdk
```
public String getMinJdk()
```
  - setMinJdk
```
public void setMinJdk(String minJdk)
```
  - getMaxJdk
```
public String getMaxJdk()
```
  - setMaxJdk
```
public void setMaxJdk(String maxJdk)
```
  - setReleaseVersionClass
```
public void setReleaseVersionClass(String className)
```
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface Validable
    
    Returns:
    
    valid xml flag
  - setValid
```
public void setValid(boolean valid)
```
    Specified by:
    
    setValid in interface Validable
    
    Parameters:
    
    valid - set validity flag
  - addError
```
public void addError(String error)
```
    Specified by:
    
    addError in interface Validable
  - getErrors
```
public Collection<String> getErrors()
```
    Specified by:
    
    getErrors in interface Validable
  - addErrors
```
public void addErrors(Collection<String> errors)
```
    Specified by:
    
    addErrors in interface Validable
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getVersion
```
public String getVersion()
```
  - setVersion
```
public void setVersion(String version)
```
  - getRepositories
```
public List<RepositoryInfo> getRepositories()
```
  - getRepositoriesByOs
```
public com.google.common.collect.ListMultimap<String,RepositoryInfo> getRepositoriesByOs()
```
    Returns:
    
    A list containing all repos for this stack, grouped by os
  - getServices
```
public Collection<ServiceInfo> getServices()
```
  - getService
```
public ServiceInfo getService(String name)
```
  - setServices
```
public void setServices(Collection<ServiceInfo> services)
```
  - getExtensions
```
public Collection<ExtensionInfo> getExtensions()
```
  - getExtension
```
public ExtensionInfo getExtension(String name)
```
  - getExtensionByService
```
public ExtensionInfo getExtensionByService(String serviceName)
```
  - addExtension
```
public void addExtension(ExtensionInfo extension)
```
  - removeExtension
```
public void removeExtension(ExtensionInfo extension)
```
  - getProperties
```
public List<PropertyInfo> getProperties()
```
  - setProperties
```
public void setProperties(List<PropertyInfo> properties)
```
  - getConfigTypeAttributes
```
public Map<String,Map<String,Map<String,String>>> getConfigTypeAttributes()
```
    Obtain the config types associated with this stack. The returned map is an unmodifiable view.
    
    Returns:
    
    copy of the map of config types associated with this stack
  - setConfigTypeAttributes
```
public void setConfigTypeAttributes(String type,
                                    Map<String,Map<String,String>> typeAttributes)
```
    Add the given type and set it's attributes.
    
    Parameters:
    
    type - configuration type
    
    typeAttributes - attributes associated with the type
  - setAllConfigAttributes
```
public void setAllConfigAttributes(Map<String,Map<String,Map<String,String>>> types)
```
    Set all types and associated attributes. Any previously existing types and attributes are removed prior to setting the new values.
    
    Parameters:
    
    types - map of type attributes
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - convertToResponse
```
public StackVersionResponse convertToResponse()
```
  - isActive
```
public boolean isActive()
```
  - setActive
```
public void setActive(boolean active)
```
  - getParentStackVersion
```
public String getParentStackVersion()
```
  - setParentStackVersion
```
public void setParentStackVersion(String parentStackVersion)
```
  - getRoleCommandOrder
```
public StackRoleCommandOrder getRoleCommandOrder()
```
  - setRoleCommandOrder
```
public void setRoleCommandOrder(StackRoleCommandOrder roleCommandOrder)
```
  - getRcoFileLocation
```
public String getRcoFileLocation()
```
  - setRcoFileLocation
```
public void setRcoFileLocation(String rcoFileLocation)
```
  - getKerberosDescriptorPreConfigurationFileLocation
```
public String getKerberosDescriptorPreConfigurationFileLocation()
```
    Gets the path to the stack-level Kerberos descriptor pre-configuration file
    
    Returns:
    
    a String containing the path to the stack-level Kerberos descriptor pre-configuration file
  - setKerberosDescriptorPreConfigurationFileLocation
```
public void setKerberosDescriptorPreConfigurationFileLocation(String kerberosDescriptorPreConfigurationFileLocation)
```
    Sets the path to the stack-level Kerberos descriptor file
    
    Parameters:
    
    kerberosDescriptorPreConfigurationFileLocation - a String containing the path to the stack-level Kerberos descriptor file
  - setUpgradesFolder
```
public void setUpgradesFolder(String path)
```
    Set the path of the stack upgrade directory.
    
    Parameters:
    
    path - the path to the upgrades directory
  - getUpgradesFolder
```
public String getUpgradesFolder()
```
    Obtain the path of the upgrades folder or null if directory doesn't exist.
    
    Returns:
    
    the upgrades folder, or null if not set
  - getUpgradePacks
```
public Map<String,UpgradePack> getUpgradePacks()
```
    Obtain all stack upgrade packs.
    
    Returns:
    
    map of upgrade pack name to upgrade pack or null if no packs
  - setUpgradePacks
```
public void setUpgradePacks(Map<String,UpgradePack> upgradePacks)
```
    Set upgrade packs.
    
    Parameters:
    
    upgradePacks - map of upgrade packs
  - getConfigUpgradePack
```
public ConfigUpgradePack getConfigUpgradePack()
```
    Get config upgrade pack for stack
    
    Returns:
    
    config upgrade pack for stack or null if it is not defined
  - setConfigUpgradePack
```
public void setConfigUpgradePack(ConfigUpgradePack configUpgradePack)
```
    Set config upgrade pack for stack
    
    Parameters:
    
    configUpgradePack - config upgrade pack for stack or null if it is not defined
  - compareTo
```
public int compareTo(StackInfo o)
```
    Specified by:
    
    compareTo in interface Comparable<StackInfo>
  - getRequiredProperties
```
public Map<String,PropertyInfo> getRequiredProperties()
```
  - getConfigPropertiesTypes
```
public Map<PropertyInfo.PropertyType,Set<String>> getConfigPropertiesTypes(String configType)
```
  - getDefaultConfigAttributesForConfigType
```
public Map<String,Map<String,String>> getDefaultConfigAttributesForConfigType(String configType)
```
    Return default config attributes for specified config type.
    
    Parameters:
    
    configType - config type
    
    Returns:
    
    config attributes
  - addVersionDefinition
```
public void addVersionDefinition(String key,
                                 VersionDefinitionXml xml)
```
    Parameters:
    
    key - the version that the xml represents
    
    xml - the version definition object
  - getVersionDefinitions
```
public Collection<VersionDefinitionXml> getVersionDefinitions()
```
    Returns:
    
    the list of available definitions on this stack
  - setRepositoryXml
```
public void setRepositoryXml(RepositoryXml rxml)
```
    Parameters:
    
    rxml - the repository xml object
  - getRepositoryXml
```
public RepositoryXml getRepositoryXml()
```
    Returns:
    
    the repository xml object, or null if it couldn't be loaded
  - getRemovedServices
```
public List<String> getRemovedServices()
```
  - setRemovedServices
```
public void setRemovedServices(List<String> removedServices)
```
  - getServicesWithNoConfigs
```
public List<String> getServicesWithNoConfigs()
```
  - setServicesWithNoConfigs
```
public void setServicesWithNoConfigs(List<String> servicesWithNoConfigs)
```
  - setLatestVersionDefinition
```
public void setLatestVersionDefinition(VersionDefinitionXml xml)
```
    Parameters:
    
    xml - the version definition parsed from LatestRepoCallable
  - getLatestVersionDefinition
```
public VersionDefinitionXml getLatestVersionDefinition()
```
    Parameters:
    
    xml - the version definition parsed from LatestRepoCallable
  - getRefreshCommandConfiguration
```
public RefreshCommandConfiguration getRefreshCommandConfiguration()
```
  - setRefreshCommandConfiguration
```
public void setRefreshCommandConfiguration(RefreshCommandConfiguration refreshCommandConfiguration)
```
  - getServiceNames
```
public Set<String> getServiceNames()
```
    Returns:
    
    names of each service in the stack
  - getReleaseVersion
```
public org.apache.ambari.spi.stack.StackReleaseVersion getReleaseVersion()
```
    Gets the instance of the StackReleaseVersion. If not specified or there is an error instantiating the class, return a default implementation.
    
    Returns:
    
    the stack release information.
  - getLibraryClassLoader
```
@Nullable
public URLClassLoader getLibraryClassLoader()
```
    Gets the ClassLoader that can be used to load classes found in JARs in the stack's library folder.
    
    Returns:
    
    the class loader for 3rd party JARs supplied by the stack or null if there are no libraries for this stack.
  - setLibraryClassLoader
```
public void setLibraryClassLoader(URLClassLoader libraryClassLoader)
```
    Sets the ClassLoader that can be used to load classes found in JARs in the stack's library folder.
    
    Parameters:
    
    libraryClassLoader - the class loader.
  - getLibraryInstance
```
public <T> T getLibraryInstance(String className)
                         throws Exception
```
    Loads an instance of the class from the stack classloader, if available.
    
    Parameters:
    
    className - the name of the class to get an instance
    
    Returns:
    
    the instance of the class
    
    Throws:
    
    Exception - when the class cannot be loaded or instantiated
  - getLibraryInstance
```
public <T> T getLibraryInstance(com.google.inject.Injector injector,
                                String className)
                         throws Exception
```
    Loads an instance of the class from the stack classloader, if available.
    
    Parameters:
    
    injector - the injector to use, or null to invoke the default, no-arg constructor
    
    className - the name of the class to get an instance
    
    Returns:
    
    the instance of the class
    
    Throws:
    
    Exception - when the class cannot be loaded or instantiated

Class StackInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackInfo

Method Detail

getMinJdk

setMinJdk

getMaxJdk

setMaxJdk

setReleaseVersionClass

isValid

setValid

addError

getErrors

addErrors

getName

setName

getVersion

setVersion

getRepositories

getRepositoriesByOs

getServices

getService

setServices

getExtensions

getExtension

getExtensionByService

addExtension

removeExtension

getProperties

setProperties

getConfigTypeAttributes

setConfigTypeAttributes

setAllConfigAttributes

toString

hashCode

equals

convertToResponse

isActive

setActive

getParentStackVersion

setParentStackVersion

getRoleCommandOrder

setRoleCommandOrder

getRcoFileLocation

setRcoFileLocation

getKerberosDescriptorPreConfigurationFileLocation

setKerberosDescriptorPreConfigurationFileLocation

setUpgradesFolder

getUpgradesFolder

getUpgradePacks

setUpgradePacks

getConfigUpgradePack

setConfigUpgradePack

compareTo

getRequiredProperties

getConfigPropertiesTypes

getDefaultConfigAttributesForConfigType

addVersionDefinition

getVersionDefinitions

setRepositoryXml

getRepositoryXml

getRemovedServices

setRemovedServices

getServicesWithNoConfigs

setServicesWithNoConfigs

setLatestVersionDefinition

getLatestVersionDefinition

getRefreshCommandConfiguration

setRefreshCommandConfiguration

getServiceNames

getReleaseVersion

getLibraryClassLoader

setLibraryClassLoader

getLibraryInstance

getLibraryInstance