ServiceDirectory (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.stack.StackDefinitionDirectory
- - org.apache.ambari.server.stack.ServiceDirectory

Direct Known Subclasses:

CommonServiceDirectory, StackServiceDirectory
```
public abstract class ServiceDirectory
extends StackDefinitionDirectory
```
Encapsulates IO operations on a stack definition service directory.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CHECKS_FOLDER_NAME` checks directory name
`protected File`	`checksDir` checks directory path
`protected static String`	`PACKAGE_FOLDER_NAME` package directory name
`protected String`	`packageDir` package directory path
`protected static String`	`SERVER_ACTIONS_FOLDER_NAME` Server actions directory name
`protected File`	`serverActionsDir` server side action directory path
`static String`	`SERVICES_FOLDER_NAME` services root directory name
`protected static String`	`UPGRADES_FOLDER_NAME` upgrades directory name
`protected File`	`upgradesDir` upgrades directory path

Fields inherited from class org.apache.ambari.server.stack.StackDefinitionDirectory
CONFIG_UPGRADE_XML_FILENAME_PREFIX, directory, XML_FILENAME_FILTER

Constructor Summary

Constructors
Constructor and Description

ServiceDirectory(String servicePath)
Constructor.

Constructors
Constructor and Description
`ServiceDirectory(String servicePath)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`calculateChecksDirectory(String stack, String service)` Sets the checksDir if the dir exists and is not empty
`protected void`	`calculateDirectories(String stack, String service)` Calculate the service specific directories.
`protected void`	`calculatePackageDirectory(String stack, String service)` Sets the packageDir if the path exists and is not empty
`protected void`	`calculateServerActionsDirectory(String stack, String service)` Sets the serverActionsDir if the dir exists and is not empty
`protected void`	`calculateUpgradesDirectory(String stack, String service)` Sets the upgradesDir if the dir exists and is not empty
`File`	`getAdvisorFile()` Obtain the advisor file.
`abstract String`	`getAdvisorName(String serviceName)` Obtain the advisor name.
`File`	`getAlertsFile()` Obtain the alerts file.
`File`	`getChecksDir()` Obtain the checks directory path.
`File`	`getKerberosDescriptorFile()` Obtain the Kerberos Descriptor file.
`ServiceMetainfoXml`	`getMetaInfoFile()` Obtain the service metainfo file object representation.
`File`	`getMetricsFile(String serviceName)` Obtain the metrics file.
`String`	`getPackageDir()` Obtain the package directory path.
`protected abstract File`	`getResourcesDirectory()`
`StackRoleCommandOrder`	`getRoleCommandOrder()` Obtain the object representation of the service role_command_order.json file
`File`	`getServerActionsDir()` Obtain the server side actions directory path.
`abstract String`	`getService()`
`abstract String`	`getStack()`
`File`	`getThemeFile()` Obtain theme file
`File`	`getUpgradesDir()` Obtain the upgrades directory path.
`File`	`getWidgetsDescriptorFile(String serviceName)` Obtain the Widgets Descriptor file.
`protected void`	`parseMetaInfoFile()` Unmarshal the metainfo file into its object representation.
`protected void`	`parsePath()` Parse the service directory.
`protected File`	`resolveDirectory(String directoryName, String stack, String service)`
`protected String`	`resolveRelativeDirectoryPathString(File resourcesDir, String directoryName, String stack, String service)`

Methods inherited from class org.apache.ambari.server.stack.StackDefinitionDirectory
getAbsolutePath, getConfigurationDirectory, getDirectory, getName, getPath

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

- Field Detail
  - packageDir
```
protected String packageDir
```
    package directory path
  - upgradesDir
```
protected File upgradesDir
```
    upgrades directory path
  - checksDir
```
protected File checksDir
```
    checks directory path
  - serverActionsDir
```
protected File serverActionsDir
```
    server side action directory path
  - SERVICES_FOLDER_NAME
```
public static final String SERVICES_FOLDER_NAME
```
    services root directory name
    
    See Also:
    
    Constant Field Values
  - PACKAGE_FOLDER_NAME
```
protected static final String PACKAGE_FOLDER_NAME
```
    package directory name
    
    See Also:
    
    Constant Field Values
  - UPGRADES_FOLDER_NAME
```
protected static final String UPGRADES_FOLDER_NAME
```
    upgrades directory name
    
    See Also:
    
    Constant Field Values
  - CHECKS_FOLDER_NAME
```
protected static final String CHECKS_FOLDER_NAME
```
    checks directory name
    
    See Also:
    
    Constant Field Values
  - SERVER_ACTIONS_FOLDER_NAME
```
protected static final String SERVER_ACTIONS_FOLDER_NAME
```
    Server actions directory name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServiceDirectory
```
public ServiceDirectory(String servicePath)
                 throws org.apache.ambari.server.AmbariException
```
    Constructor.
    
    Parameters:
    
    servicePath - path of the service directory
    
    Throws:
    
    org.apache.ambari.server.AmbariException - if unable to parse the service directory
- Method Detail
  - getPackageDir
```
public String getPackageDir()
```
    Obtain the package directory path.
    
    Returns:
    
    package directory path
  - getUpgradesDir
```
public File getUpgradesDir()
```
    Obtain the upgrades directory path.
    
    Returns:
    
    upgrades directory path
  - getChecksDir
```
public File getChecksDir()
```
    Obtain the checks directory path.
    
    Returns:
    
    checks directory path
  - getServerActionsDir
```
public File getServerActionsDir()
```
    Obtain the server side actions directory path.
    
    Returns:
    
    server side actions directory path
  - getMetricsFile
```
public File getMetricsFile(String serviceName)
```
    Obtain the metrics file.
    
    Returns:
    
    metrics file
  - getAdvisorFile
```
public File getAdvisorFile()
```
    Obtain the advisor file.
    
    Returns:
    
    advisor file
  - getAdvisorName
```
public abstract String getAdvisorName(String serviceName)
```
    Obtain the advisor name.
    
    Returns:
    
    advisor name
  - getAlertsFile
```
public File getAlertsFile()
```
    Obtain the alerts file.
    
    Returns:
    
    alerts file
  - getThemeFile
```
public File getThemeFile()
```
    Obtain theme file
    
    Returns:
    
    theme file
  - getKerberosDescriptorFile
```
public File getKerberosDescriptorFile()
```
    Obtain the Kerberos Descriptor file.
    
    Returns:
    
    Kerberos Descriptor file
  - getWidgetsDescriptorFile
```
public File getWidgetsDescriptorFile(String serviceName)
```
    Obtain the Widgets Descriptor file.
    
    Returns:
    
    Widgets Descriptor file
  - getMetaInfoFile
```
public ServiceMetainfoXml getMetaInfoFile()
```
    Obtain the service metainfo file object representation.
    
    Returns:
    
    Obtain the service metainfo file object representation
  - getRoleCommandOrder
```
public StackRoleCommandOrder getRoleCommandOrder()
```
    Obtain the object representation of the service role_command_order.json file
    
    Returns:
    
    object representation of the service role_command_order.json file
  - parsePath
```
protected void parsePath()
                  throws org.apache.ambari.server.AmbariException
```
    Parse the service directory.
    
    Throws:
    
    org.apache.ambari.server.AmbariException
  - getService
```
public abstract String getService()
```
    Returns:
    
    the service identifier required. ex: service name for stack services or the service/version for common services
  - getStack
```
public abstract String getStack()
```
    Returns:
    
    the stack name/version or common-services
  - calculateDirectories
```
protected void calculateDirectories(String stack,
                                    String service)
```
    Calculate the service specific directories.
  - resolveDirectory
```
protected File resolveDirectory(String directoryName,
                                String stack,
                                String service)
```
    Parameters:
    
    directoryName -
    
    stack -
    
    service -
    
    Returns:
    
    the directory if it exists and is not empty
  - resolveRelativeDirectoryPathString
```
protected String resolveRelativeDirectoryPathString(File resourcesDir,
                                                    String directoryName,
                                                    String stack,
                                                    String service)
```
    Parameters:
    
    directoryName -
    
    stack -
    
    service -
    
    Returns:
    
    the relative path of the directory if it exists and is not empty
  - getResourcesDirectory
```
protected abstract File getResourcesDirectory()
```
    Returns:
    
    the resources directory
  - calculatePackageDirectory
```
protected void calculatePackageDirectory(String stack,
                                         String service)
```
    Sets the packageDir if the path exists and is not empty
    
    Parameters:
    
    stack -
    
    service -
  - calculateUpgradesDirectory
```
protected void calculateUpgradesDirectory(String stack,
                                          String service)
```
    Sets the upgradesDir if the dir exists and is not empty
    
    Parameters:
    
    stack -
    
    service -
  - calculateChecksDirectory
```
protected void calculateChecksDirectory(String stack,
                                        String service)
```
    Sets the checksDir if the dir exists and is not empty
    
    Parameters:
    
    stack -
    
    service -
  - calculateServerActionsDirectory
```
protected void calculateServerActionsDirectory(String stack,
                                               String service)
```
    Sets the serverActionsDir if the dir exists and is not empty
    
    Parameters:
    
    stack -
    
    service -
  - parseMetaInfoFile
```
protected void parseMetaInfoFile()
                          throws org.apache.ambari.server.AmbariException
```
    Unmarshal the metainfo file into its object representation.
    
    Throws:
    
    org.apache.ambari.server.AmbariException - if the metainfo file doesn't exist or unable to unmarshal the metainfo file

Class ServiceDirectory

Field Summary

Fields inherited from class org.apache.ambari.server.stack.StackDefinitionDirectory

Constructor Summary

Method Summary

Methods inherited from class org.apache.ambari.server.stack.StackDefinitionDirectory

Methods inherited from class java.lang.Object

Field Detail

packageDir

upgradesDir

checksDir

serverActionsDir

SERVICES_FOLDER_NAME

PACKAGE_FOLDER_NAME

UPGRADES_FOLDER_NAME

CHECKS_FOLDER_NAME

SERVER_ACTIONS_FOLDER_NAME

Constructor Detail

ServiceDirectory

Method Detail

getPackageDir

getUpgradesDir

getChecksDir

getServerActionsDir

getMetricsFile

getAdvisorFile

getAdvisorName

getAlertsFile

getThemeFile

getKerberosDescriptorFile

getWidgetsDescriptorFile

getMetaInfoFile

getRoleCommandOrder

parsePath

getService

getStack

calculateDirectories

resolveDirectory

resolveRelativeDirectoryPathString

getResourcesDirectory

calculatePackageDirectory

calculateUpgradesDirectory

calculateChecksDirectory

calculateServerActionsDirectory

parseMetaInfoFile