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 FilenameFilter	FILENAME_FILTER
static String	RCO_FILE_NAME
static String	SCHEMA_VERSION_2 Version of XML files with support of custom services and custom commands
static String	SCHEMA_VERSION_LEGACY Value for legacy xml files that don't contain schema property
static String	SERVICE_CONFIG_FILE_NAME_POSTFIX
static String	SERVICE_CONFIG_FOLDER_NAME
static String	SERVICE_METAINFO_FILE_NAME
static String	SERVICE_METRIC_FILE_NAME
static String	SERVICES_FOLDER_NAME
static String	STACK_METAINFO_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
AmbariMetaInfo(Configuration conf) Ambari Meta Info Object
AmbariMetaInfo(File stackRoot, File serverVersionFile)

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
List<ActionDefinition>	getAllActionDefinition() Get all action definitions
ComponentInfo	getComponent(String stackName, String version, String serviceName, String componentName)
ComponentInfo	getComponentCategory(String stackName, String version, String serviceName, String componentName) Get component category
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.
List<MetricDefinition>	getMetrics(String stackName, String stackVersion, String serviceName, String componentName, String metricType) Gets the metrics for a Role (component).
OperatingSystemInfo	getOperatingSystem(String stackName, String version, String osType)
Set<OperatingSystemInfo>	getOperatingSystems(String stackName, String version) Lists operatingsystems supported by stack
Set<PropertyInfo>	getProperties(String stackName, String version, String serviceName)
PropertyInfo	getProperty(String stackName, String version, String serviceName, String propertyName)
List<RepositoryInfo>	getRepositories(String stackName, String version, String osType)
Map<String,List<RepositoryInfo>>	getRepository(String stackName, String version)
RepositoryInfo	getRepository(String stackName, String version, String osType, String repoId)
String	getServerVersion()
ServiceInfo	getService(String stackName, String version, String serviceName)
ServiceInfo	getServiceInfo(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
Stack	getStack(String stackName)
StackInfo	getStackInfo(String stackName, String version)
Set<StackInfo>	getStackInfos(String stackName)
Set<Stack>	getStackNames()
File	getStackRoot()
Map<String,Map<String,String>>	getSupportedConfigs(String stackName, String version, String serviceName) Get the service configs supported for a service in a particular stack
List<ServiceInfo>	getSupportedServices(String stackName, String version)
List<StackInfo>	getSupportedStacks()
void	init() Initialize the Ambari Meta Info
boolean	isOsSupported(String osType)
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	updateRepoBaseURL(String stackName, String stackVersion, String osType, String repoId, String newBaseUrl)

Methods inherited from class java.lang.Object

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

Field Detail

STACK_METAINFO_FILE_NAME

public static final String STACK_METAINFO_FILE_NAME

See Also:

Constant Field Values

SERVICES_FOLDER_NAME

public static final String SERVICES_FOLDER_NAME

See Also:

Constant Field Values

SERVICE_METAINFO_FILE_NAME

public static final String SERVICE_METAINFO_FILE_NAME

See Also:

Constant Field Values

SERVICE_CONFIG_FOLDER_NAME

public static final String SERVICE_CONFIG_FOLDER_NAME

See Also:

Constant Field Values

SERVICE_CONFIG_FILE_NAME_POSTFIX

public static final String SERVICE_CONFIG_FILE_NAME_POSTFIX

See Also:

Constant Field Values

RCO_FILE_NAME

public static final String RCO_FILE_NAME

See Also:

Constant Field Values

SERVICE_METRIC_FILE_NAME

public static final String SERVICE_METRIC_FILE_NAME

See Also:

Constant Field Values

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_LEGACY

public static final String SCHEMA_VERSION_LEGACY

Value for legacy xml files that don't contain schema property

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

FILENAME_FILTER

public static final FilenameFilter FILENAME_FILTER

Constructor Detail

AmbariMetaInfo

@Inject
public AmbariMetaInfo(Configuration conf)
                       throws Exception

Ambari Meta Info Object

Parameters:

conf - Configuration API to be used.

Throws:

Exception

AmbariMetaInfo

public AmbariMetaInfo(File stackRoot,
                      File serverVersionFile)
               throws Exception

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.

getComponentCategory

public ComponentInfo getComponentCategory(String stackName,
                                          String version,
                                          String serviceName,
                                          String componentName)
                                   throws AmbariException

Get component category

Parameters:

stackName -

version -

serviceName -

componentName -

Returns:

component component Info

Throws:

AmbariException

getComponentsByService

public List<ComponentInfo> getComponentsByService(String stackName,
                                                  String version,
                                                  String serviceName)
                                           throws AmbariException

Get components by service

Parameters:

stackName -

version -

serviceName -

Returns:

Throws:

AmbariException

getComponent

public ComponentInfo getComponent(String stackName,
                                  String version,
                                  String serviceName,
                                  String componentName)
                           throws AmbariException

Throws:

AmbariException

getRepository

public Map<String,List<RepositoryInfo>> getRepository(String stackName,
                                                      String version)
                                               throws AmbariException

Throws:

AmbariException

getRepositories

public List<RepositoryInfo> getRepositories(String stackName,
                                            String version,
                                            String osType)
                                     throws AmbariException

Throws:

AmbariException

getRepository

public RepositoryInfo getRepository(String stackName,
                                    String version,
                                    String osType,
                                    String repoId)
                             throws AmbariException

Throws:

AmbariException

isSupportedStack

public boolean isSupportedStack(String stackName,
                                String version)
                         throws AmbariException

Throws:

AmbariException

isValidService

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

Throws:

AmbariException

isValidServiceComponent

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

Throws:

AmbariException

getComponentToService

public String getComponentToService(String stackName,
                                    String version,
                                    String componentName)
                             throws 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:

AmbariException

getSupportedConfigs

public Map<String,Map<String,String>> getSupportedConfigs(String stackName,
                                                          String version,
                                                          String serviceName)
                                                   throws AmbariException

Get the service configs supported for a service in a particular stack

Parameters:

stackName - the stack name

version - the version of the stack

serviceName - the name of the service in the stack

Returns:

the config knobs supported for the service

Throws:

AmbariException

getServices

public Map<String,ServiceInfo> getServices(String stackName,
                                           String version)
                                    throws 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 varios services that are supported in the stack

Throws:

AmbariException

getService

public ServiceInfo getService(String stackName,
                              String version,
                              String serviceName)
                       throws AmbariException

Throws:

AmbariException

getServiceInfo

public ServiceInfo getServiceInfo(String stackName,
                                  String version,
                                  String serviceName)
                           throws AmbariException

Throws:

AmbariException

getSupportedServices

public List<ServiceInfo> getSupportedServices(String stackName,
                                              String version)
                                       throws AmbariException

Throws:

AmbariException

getSupportedStacks

public List<StackInfo> getSupportedStacks()

getStackNames

public Set<Stack> getStackNames()

getStack

public Stack getStack(String stackName)
               throws AmbariException

Throws:

AmbariException

getStackInfos

public Set<StackInfo> getStackInfos(String stackName)

getStackInfo

public StackInfo getStackInfo(String stackName,
                              String version)
                       throws AmbariException

Throws:

AmbariException

getProperties

public Set<PropertyInfo> getProperties(String stackName,
                                       String version,
                                       String serviceName)
                                throws AmbariException

Throws:

AmbariException

getProperty

public PropertyInfo getProperty(String stackName,
                                String version,
                                String serviceName,
                                String propertyName)
                         throws AmbariException

Throws:

AmbariException

getOperatingSystems

public Set<OperatingSystemInfo> getOperatingSystems(String stackName,
                                                    String version)
                                             throws AmbariException

Lists operatingsystems supported by stack

Throws:

AmbariException

getOperatingSystem

public OperatingSystemInfo getOperatingSystem(String stackName,
                                              String version,
                                              String osType)
                                       throws AmbariException

Throws:

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 AmbariException

Used for test purposes

Throws:

AmbariException

getServerVersion

public String getServerVersion()

isOsSupported

public boolean isOsSupported(String osType)

updateRepoBaseURL

public void updateRepoBaseURL(String stackName,
                              String stackVersion,
                              String osType,
                              String repoId,
                              String newBaseUrl)
                       throws AmbariException

Parameters:

stackName - the stack name

stackVersion - the stack version

osType - the os

repoId - the repo id

newBaseUrl - the new base url

Throws:

AmbariException

getStackRoot

public File getStackRoot()

getMetrics

public List<MetricDefinition> getMetrics(String stackName,
                                         String stackVersion,
                                         String serviceName,
                                         String componentName,
                                         String metricType)
                                  throws AmbariException

Gets the metrics for a Role (component).

Returns:

the list of defined metrics.

Throws:

AmbariException