org.apache.ambari.server.api.services

Class AmbariMetaInfo

java.lang.Object

org.apache.ambari.server.api.services.AmbariMetaInfo

public class AmbariMetaInfo
extends Object

ServiceInfo responsible getting information about cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_OS This string is used in placeholder in places that are common for all operating systems or in situations where os type is not important.
static String	KERBEROS_DESCRIPTOR_FILE_NAME The filename for a Kerberos descriptor file at either the stack or service level
static String	SCHEMA_VERSION_2 Version of XML files with support of custom services and custom commands
static String	WIDGETS_DESCRIPTOR_FILE_NAME The filename for a Widgets descriptor file at either the stack or service level

Constructor Summary

Constructors

Constructor and Description
AmbariMetaInfo(Configuration conf) Ambari Meta Info Object

Method Summary

Modifier and Type	Method and Description
void	addActionDefinition(ActionDefinition ad) Used for test purposes
ActionDefinition	getActionDefinition(String name) Get action definitions based on the supplied name
Set<AlertDefinition>	getAlertDefinitions(ServiceInfo service) Gets the alert definitions for the specified stack and service.
Set<AlertDefinition>	getAlertDefinitions(String stackName, String stackVersion, String serviceName) Gets the alert definitions for the specified stack and service.
List<ActionDefinition>	getAllActionDefinition() Get all action definitions
Map<String,String>	getAmbariServerProperties()
protected String	getCommonKerberosDescriptorFileLocation() Gets the path to the common Kerberos descriptor file
File	getCommonWidgetsDescriptorFile()
ComponentInfo	getComponent(String stackName, String version, String serviceName, String componentName)
List<DependencyInfo>	getComponentDependencies(String stackName, String version, String service, String component) Get all dependencies for a component.
DependencyInfo	getComponentDependency(String stackName, String version, String service, String component, String dependencyName) Obtain a specific dependency by name.
List<ComponentInfo>	getComponentsByService(String stackName, String version, String serviceName) Get components by service
String	getComponentToService(String stackName, String version, String componentName) Get the name of a service given the component name.
ConfigUpgradePack	getConfigUpgradePack(String stackName, String stackVersion) Get all upgrade config pack if it is available for a stack.
ExtensionInfo	getExtension(String extensionName, String version)
Collection<ExtensionInfo>	getExtensions()
Collection<ExtensionInfo>	getExtensions(String extensionName)
File	getExtensionsRoot()
KerberosServiceDescriptor[]	getKerberosDescriptor(ServiceInfo serviceInfo) Gets the requested service-level Kerberos descriptor(s) An array of descriptors are returned since the kerberos.json in a service directory may contain descriptor details for one or more services.
KerberosDescriptor	getKerberosDescriptor(String stackName, String stackVersion, boolean includePreconfigureData) Gets the fully compiled Kerberos descriptor for the relevant stack and version.
List<MetricDefinition>	getMetrics(String stackName, String stackVersion, String serviceName, String componentName, String metricType) Gets the metrics for a Role (component).
List<Module>	getModules(Long mpackId) Gets the module information for given mpack.
Collection<String>	getMonitoringServiceNames(String stackName, String version)
Mpack	getMpack(Long mpackId) Fetch a particular mpack based on mpackid
MpackManager	getMpackManager() Obtain the underlying mpack manager.
Collection<Mpack>	getMpacks()
OperatingSystemInfo	getOperatingSystem(String stackName, String version, String osType)
Set<OperatingSystemInfo>	getOperatingSystems(String stackName, String version) Lists operatingsystems supported by stack
Set<PropertyInfo>	getPropertiesByName(String stackName, String version, String serviceName, String propertyName)
Set<String>	getRackSensitiveServicesNames(String stackName, String version) Get the set of names of services which require restart when host rack information is changed.
List<RepositoryInfo>	getRepositories(String stackName, String version, String osType)
Map<String,List<RepositoryInfo>>	getRepository(String stackName, String version) Gets repositories that are keyed by operating system type.
RepositoryInfo	getRepository(String stackName, String version, String osType, String repoId)
Set<String>	getRestartRequiredServicesNames(String stackName, String version)
String	getServerVersion()
ServiceInfo	getService(Service service) Convenience method to use stack id instead of separate name and version.
ServiceInfo	getService(String stackName, String version, String serviceName)
Map<String,Map<String,List<MetricDefinition>>>	getServiceMetrics(String stackName, String stackVersion, String serviceName) Return metrics for a stack service.
Set<PropertyInfo>	getServiceProperties(String stackName, String version, String serviceName)
Map<String,ServiceInfo>	getServices(String stackName, String version) Given a stack name and version return all the services with info
StackInfo	getStack(StackId stackId) Convenience method to get stack info from a stack id
StackInfo	getStack(String stackName, String version)
StackManager	getStackManager() Obtain the underlying stack manager.
List<String>	getStackParentVersions(String stackName, String version)
Set<PropertyInfo>	getStackProperties(String stackName, String version)
Set<PropertyInfo>	getStackPropertiesByName(String stackName, String version, String propertyName)
File	getStackRoot()
Collection<StackInfo>	getStacks()
Collection<StackInfo>	getStacks(String stackName)
Map<String,UpgradePack>	getUpgradePacks(String stackName, String stackVersion) Get all upgrade packs available for a stack.
VersionDefinitionXml	getVersionDefinition(String versionDefinitionId)
Map<String,VersionDefinitionXml>	getVersionDefinitions()
void	init() Initialize the Ambari Meta Info
boolean	isOsSupported(String osType)
boolean	isServiceRemovedInStack(String stackName, String version, String serviceName)
boolean	isServiceWithNoConfigs(String stackName, String version, String serviceName)
boolean	isSupportedStack(String stackName, String version)
boolean	isValidService(String stackName, String version, String serviceName)
boolean	isValidServiceComponent(String stackName, String version, String serviceName, String componentName)
void	reconcileAlertDefinitions(Cluster cluster, boolean updateScriptPaths) Compares the alert definitions defined on the stack with those in the database and merges any new or updated definitions.
void	reconcileAlertDefinitions(Clusters clusters, boolean updateScriptPaths) Compares the alert definitions defined on the stack with those in the database and merges any new or updated definitions.
MpackResponse	registerMpack(MpackRequest mpackRequest) Calls the registerMpack method from mpackManager to support a POST /mpacks request
void	removeMpack(MpackEntity mpackEntity, StackEntity stackEntity) Remove Mpack from the mpackMap and stackMap which is used to power the Mpack and Stack APIs.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_OS

public static final String ANY_OS

This string is used in placeholder in places that are common for all operating systems or in situations where os type is not important.

See Also:

Constant Field Values

SCHEMA_VERSION_2

public static final String SCHEMA_VERSION_2

Version of XML files with support of custom services and custom commands

See Also:

Constant Field Values

KERBEROS_DESCRIPTOR_FILE_NAME

public static final String KERBEROS_DESCRIPTOR_FILE_NAME

The filename for a Kerberos descriptor file at either the stack or service level

See Also:

Constant Field Values

WIDGETS_DESCRIPTOR_FILE_NAME

public static final String WIDGETS_DESCRIPTOR_FILE_NAME

The filename for a Widgets descriptor file at either the stack or service level

See Also:

Constant Field Values

Constructor Detail

AmbariMetaInfo

@Inject
public AmbariMetaInfo(Configuration conf)
                       throws Exception

Ambari Meta Info Object

Parameters:

conf - Configuration API to be used.

Throws:

Exception

Method Detail

init

@Inject
public void init()
                  throws Exception

Initialize the Ambari Meta Info

Throws:

Exception - throws exception if not able to parse the Meta data.

getStackManager

public StackManager getStackManager()

Obtain the underlying stack manager.

Returns:

stack manager

getMpackManager

public MpackManager getMpackManager()

Obtain the underlying mpack manager.

Returns:

mpack manager

getComponentsByService

public List<ComponentInfo> getComponentsByService(String stackName,
                                                  String version,
                                                  String serviceName)
                                           throws org.apache.ambari.server.AmbariException

Get components by service

Parameters:

stackName - stack name

version - stack version

serviceName - service name

Returns:

List of ComponentInfo objects

Throws:

org.apache.ambari.server.AmbariException

getComponent

public ComponentInfo getComponent(String stackName,
                                  String version,
                                  String serviceName,
                                  String componentName)
                           throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getComponentDependencies

public List<DependencyInfo> getComponentDependencies(String stackName,
                                                     String version,
                                                     String service,
                                                     String component)
                                              throws org.apache.ambari.server.AmbariException

Get all dependencies for a component.

Parameters:

stackName - stack name

version - stack version

service - service name

component - component name

Returns:

List of dependencies for the given component

Throws:

org.apache.ambari.server.AmbariException - if unable to obtain the dependencies for the component

getComponentDependency

public DependencyInfo getComponentDependency(String stackName,
                                             String version,
                                             String service,
                                             String component,
                                             String dependencyName)
                                      throws org.apache.ambari.server.AmbariException

Obtain a specific dependency by name.

Parameters:

stackName - stack name

version - stack version

service - service name

component - component name

dependencyName - dependency component name

Returns:

the requested dependency

Throws:

org.apache.ambari.server.AmbariException - if unable to obtain the requested dependency

getRepository

public Map<String,List<RepositoryInfo>> getRepository(String stackName,
                                                      String version)
                                               throws org.apache.ambari.server.AmbariException

Gets repositories that are keyed by operating system type.

Parameters:

stackName - the stack name

version - the stack version

Returns:

Throws:

org.apache.ambari.server.AmbariException

getRepositories

public List<RepositoryInfo> getRepositories(String stackName,
                                            String version,
                                            String osType)
                                     throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getRepository

public RepositoryInfo getRepository(String stackName,
                                    String version,
                                    String osType,
                                    String repoId)
                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

isSupportedStack

public boolean isSupportedStack(String stackName,
                                String version)

isValidService

public boolean isValidService(String stackName,
                              String version,
                              String serviceName)

isValidServiceComponent

public boolean isValidServiceComponent(String stackName,
                                       String version,
                                       String serviceName,
                                       String componentName)

getComponentToService

public String getComponentToService(String stackName,
                                    String version,
                                    String componentName)
                             throws org.apache.ambari.server.AmbariException

Get the name of a service given the component name.

Parameters:

stackName - the stack name

version - the stack version

componentName - the component name

Returns:

the service name

Throws:

org.apache.ambari.server.AmbariException

getServices

public Map<String,ServiceInfo> getServices(String stackName,
                                           String version)
                                    throws org.apache.ambari.server.AmbariException

Given a stack name and version return all the services with info

Parameters:

stackName - the stack name

version - the version of the stack

Returns:

the information of abt various services that are supported in the stack

Throws:

org.apache.ambari.server.AmbariException

getService

public ServiceInfo getService(Service service)
                       throws org.apache.ambari.server.AmbariException

Convenience method to use stack id instead of separate name and version.

Parameters:

service - the service business object

Returns:

the service info instance defined from the stack for the business object

Throws:

org.apache.ambari.server.AmbariException

getService

public ServiceInfo getService(String stackName,
                              String version,
                              String serviceName)
                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

isServiceRemovedInStack

public boolean isServiceRemovedInStack(String stackName,
                                       String version,
                                       String serviceName)
                                throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

isServiceWithNoConfigs

public boolean isServiceWithNoConfigs(String stackName,
                                      String version,
                                      String serviceName)
                               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getMonitoringServiceNames

public Collection<String> getMonitoringServiceNames(String stackName,
                                                    String version)
                                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getRestartRequiredServicesNames

public Set<String> getRestartRequiredServicesNames(String stackName,
                                                   String version)
                                            throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getRackSensitiveServicesNames

public Set<String> getRackSensitiveServicesNames(String stackName,
                                                 String version)
                                          throws org.apache.ambari.server.AmbariException

Get the set of names of services which require restart when host rack information is changed.

Parameters:

stackName - the stack name

version - the stack version

Returns:

the set of services which require restart when host rack information is changed

Throws:

org.apache.ambari.server.AmbariException - if the service set can not be acquired

getStacks

public Collection<StackInfo> getStacks()

registerMpack

public MpackResponse registerMpack(MpackRequest mpackRequest)
                            throws IOException,
                                   ResourceAlreadyExistsException

Calls the registerMpack method from mpackManager to support a POST /mpacks request

Parameters:

mpackRequest -

Returns:

MpackResponse

Throws:

IOException

ResourceAlreadyExistsException

getModules

public List<Module> getModules(Long mpackId)

Gets the module information for given mpack.

Parameters:

mpackId -

Returns:

List of Modules.

getStacks

public Collection<StackInfo> getStacks(String stackName)
                                throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getStack

public StackInfo getStack(StackId stackId)
                   throws org.apache.ambari.server.AmbariException

Convenience method to get stack info from a stack id

Parameters:

stackId - the stack id

Returns:

the stack info

Throws:

org.apache.ambari.server.AmbariException

getStack

public StackInfo getStack(String stackName,
                          String version)
                   throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getStackParentVersions

public List<String> getStackParentVersions(String stackName,
                                           String version)

getExtensions

public Collection<ExtensionInfo> getExtensions()

getExtensions

public Collection<ExtensionInfo> getExtensions(String extensionName)
                                        throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getExtension

public ExtensionInfo getExtension(String extensionName,
                                  String version)
                           throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getServiceProperties

public Set<PropertyInfo> getServiceProperties(String stackName,
                                              String version,
                                              String serviceName)
                                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getStackProperties

public Set<PropertyInfo> getStackProperties(String stackName,
                                            String version)
                                     throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getPropertiesByName

public Set<PropertyInfo> getPropertiesByName(String stackName,
                                             String version,
                                             String serviceName,
                                             String propertyName)
                                      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getStackPropertiesByName

public Set<PropertyInfo> getStackPropertiesByName(String stackName,
                                                  String version,
                                                  String propertyName)
                                           throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getOperatingSystems

public Set<OperatingSystemInfo> getOperatingSystems(String stackName,
                                                    String version)
                                             throws org.apache.ambari.server.AmbariException

Lists operatingsystems supported by stack

Throws:

org.apache.ambari.server.AmbariException

getOperatingSystem

public OperatingSystemInfo getOperatingSystem(String stackName,
                                              String version,
                                              String osType)
                                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getAllActionDefinition

public List<ActionDefinition> getAllActionDefinition()

Get all action definitions

getActionDefinition

public ActionDefinition getActionDefinition(String name)

Get action definitions based on the supplied name

addActionDefinition

public void addActionDefinition(ActionDefinition ad)
                         throws org.apache.ambari.server.AmbariException

Used for test purposes

Throws:

org.apache.ambari.server.AmbariException

getServerVersion

public String getServerVersion()

isOsSupported

public boolean isOsSupported(String osType)

getStackRoot

public File getStackRoot()

getExtensionsRoot

public File getExtensionsRoot()

getServiceMetrics

public Map<String,Map<String,List<MetricDefinition>>> getServiceMetrics(String stackName,
                                                                        String stackVersion,
                                                                        String serviceName)
                                                                 throws org.apache.ambari.server.AmbariException

Return metrics for a stack service.

Throws:

org.apache.ambari.server.AmbariException

getMetrics

public List<MetricDefinition> getMetrics(String stackName,
                                         String stackVersion,
                                         String serviceName,
                                         String componentName,
                                         String metricType)
                                  throws org.apache.ambari.server.AmbariException

Gets the metrics for a Role (component).

Returns:

the list of defined metrics.

Throws:

org.apache.ambari.server.AmbariException

getAlertDefinitions

public Set<AlertDefinition> getAlertDefinitions(String stackName,
                                                String stackVersion,
                                                String serviceName)
                                         throws org.apache.ambari.server.AmbariException

Gets the alert definitions for the specified stack and service.

Parameters:

stackName - the stack name

stackVersion - the stack version

serviceName - the service name

Returns:

the alert definitions for a stack or an empty list if none (never null).

Throws:

org.apache.ambari.server.AmbariException

getAlertDefinitions

public Set<AlertDefinition> getAlertDefinitions(ServiceInfo service)
                                         throws org.apache.ambari.server.AmbariException

Gets the alert definitions for the specified stack and service.

Parameters:

service - the service name

Returns:

the alert definitions for a stack or an empty list if none (never null).

Throws:

org.apache.ambari.server.AmbariException

reconcileAlertDefinitions

public void reconcileAlertDefinitions(Clusters clusters,
                                      boolean updateScriptPaths)
                               throws org.apache.ambari.server.AmbariException

Compares the alert definitions defined on the stack with those in the database and merges any new or updated definitions. This method will first determine the services that are installed on each cluster to prevent alert definitions from undeployed services from being shown.

This method will also detect "agent" alert definitions, which are definitions that should be run on agent hosts but are not associated with a service.

Parameters:

clusters - all clusters

updateScriptPaths - whether existing script-based alerts should be updated with possibly new paths from the stack definition

Throws:

org.apache.ambari.server.AmbariException

reconcileAlertDefinitions

public void reconcileAlertDefinitions(Cluster cluster,
                                      boolean updateScriptPaths)
                               throws org.apache.ambari.server.AmbariException

Compares the alert definitions defined on the stack with those in the database and merges any new or updated definitions. This method will first determine the services that are installed on each cluster to prevent alert definitions from undeployed services from being shown.

This method will also detect "agent" alert definitions, which are definitions that should be run on agent hosts but are not associated with a service.

Parameters:

cluster - cluster

updateScriptPaths - whether existing script-based alerts should be updated with possibly new paths from the stack definition

Throws:

org.apache.ambari.server.AmbariException

getUpgradePacks

public Map<String,UpgradePack> getUpgradePacks(String stackName,
                                               String stackVersion)

Get all upgrade packs available for a stack.

Parameters:

stackName - the stack name

stackVersion - the stack version

Returns:

a map of upgrade packs, keyed by the name of the upgrade pack

getConfigUpgradePack

public ConfigUpgradePack getConfigUpgradePack(String stackName,
                                              String stackVersion)

Get all upgrade config pack if it is available for a stack.

Parameters:

stackName - the stack name

stackVersion - the stack version

Returns:

config upgrade pack for stack or null if it is not defined for stack

getKerberosDescriptor

public KerberosDescriptor getKerberosDescriptor(String stackName,
                                                String stackVersion,
                                                boolean includePreconfigureData)
                                         throws org.apache.ambari.server.AmbariException

Gets the fully compiled Kerberos descriptor for the relevant stack and version.

All of the kerberos.json files from the specified stack (and version) are read, parsed and complied into a complete Kerberos descriptor hierarchy.

Parameters:

stackName - a String declaring the stack name

stackVersion - a String declaring the stack version

includePreconfigureData - a Boolean value indicating whether to include the pre-configuration data (true), or not (false)

Returns:

a new complete KerberosDescriptor, or null if no Kerberos descriptor information is available

Throws:

org.apache.ambari.server.AmbariException - if an error occurs reading or parsing the stack's kerberos.json files

getCommonKerberosDescriptorFileLocation

protected String getCommonKerberosDescriptorFileLocation()

Gets the path to the common Kerberos descriptor file

Returns:

a String containing the path to the common Kerberos descriptor file

getKerberosDescriptor

public KerberosServiceDescriptor[] getKerberosDescriptor(ServiceInfo serviceInfo)
                                                  throws org.apache.ambari.server.AmbariException

Gets the requested service-level Kerberos descriptor(s)

An array of descriptors are returned since the kerberos.json in a service directory may contain descriptor details for one or more services.

Parameters:

serviceInfo - a ServiceInfo declaring the stack name, version, a service (directory) name details

Returns:

an array of KerberosServiceDescriptors, or null if the relevant service (directory) does not contain Kerberos descriptor details

Throws:

org.apache.ambari.server.AmbariException - if an error occurs reading or parsing the service's kerberos.json files

getAmbariServerProperties

public Map<String,String> getAmbariServerProperties()

getVersionDefinition

public VersionDefinitionXml getVersionDefinition(String versionDefinitionId)

Parameters:

versionDefinitionId - the version definition id

Returns:

the definition, or null if not found

getVersionDefinitions

public Map<String,VersionDefinitionXml> getVersionDefinitions()

Returns:

the version definitions found for stacks

getCommonWidgetsDescriptorFile

public File getCommonWidgetsDescriptorFile()

removeMpack

public void removeMpack(MpackEntity mpackEntity,
                        StackEntity stackEntity)
                 throws IOException

Remove Mpack from the mpackMap and stackMap which is used to power the Mpack and Stack APIs. Stack should be removed from stackMap only if it points to the mpack that is being removed.

Parameters:

mpackEntity -

stackEntity -

Throws:

IOException

getMpacks

public Collection<Mpack> getMpacks()

getMpack

public Mpack getMpack(Long mpackId)

Fetch a particular mpack based on mpackid

Returns:

a single mpack