org.apache.ambari.server.state.repository

Class VersionDefinitionXml

java.lang.Object

org.apache.ambari.server.state.repository.VersionDefinitionXml

public class VersionDefinitionXml
extends Object

Class that wraps a repository definition file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionDefinitionXml.Merger Used to facilitate merging when multiple version definitions are provided.

Field Summary

Fields

Modifier and Type	Field and Description
Release	release Release details.
RepositoryXml	repositoryInfo Represents the repository details.
static String	SCHEMA_LOCATION
String	xsdLocation The xsd location.

Constructor Summary

Constructors

Constructor and Description
VersionDefinitionXml()

Method Summary

Modifier and Type	Method and Description
static VersionDefinitionXml	build(StackInfo stackInfo) Builds a Version Definition that is the default for the stack.
Collection<AvailableService>	getAvailableServices(StackInfo stack)
ClusterVersionSummary	getClusterSummary(Cluster cluster, AmbariMetaInfo metaInfo) Gets a summary for cluster given the version information in this version.
Set<String>	getMissingDependencies(Cluster cluster, AmbariMetaInfo metaInfo) Gets information about services which cannot be upgraded because the repository does not contain required dependencies.
String	getPackageVersion(String osFamily) Gets the package version for an OS family
List<ManifestServiceInfo>	getStackServices(StackInfo stack) Gets the list of stack services, applying information from the version definition.
boolean	isStackDefault() Gets if the version definition was built as the default for a stack
static VersionDefinitionXml	load(String xml) Parses an xml string.
static VersionDefinitionXml	load(URL url) Parses a URL for a definition XML file into the object graph.
void	setStackDefault(boolean stackDefault) Sets if the version definition is a stack default.
String	toXml() Returns the XML representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_LOCATION

public static final String SCHEMA_LOCATION

See Also:

Constant Field Values

release

public Release release

Release details.

repositoryInfo

public RepositoryXml repositoryInfo

Represents the repository details. This is reused from stack repo info.

xsdLocation

public String xsdLocation

The xsd location. Never null.

Constructor Detail

VersionDefinitionXml

public VersionDefinitionXml()

Method Detail

getAvailableServices

public Collection<AvailableService> getAvailableServices(StackInfo stack)

Parameters:

stack - the stack info needed to lookup service and component display names

Returns:

a collection of AvailableServices used for web service consumption. This collection is either the subset of the manifest, or the manifest itself if no services are specified as "available".

setStackDefault

public void setStackDefault(boolean stackDefault)

Sets if the version definition is a stack default. This can only be true when parsing "latest-vdf" for a stack.

isStackDefault

public boolean isStackDefault()

Gets if the version definition was built as the default for a stack

Returns:

true if default for a stack

getStackServices

public List<ManifestServiceInfo> getStackServices(StackInfo stack)

Gets the list of stack services, applying information from the version definition. This will include both services which advertise a version and those which do not.

Parameters:

stack - the stack for which to get the information

Returns:

the list of ManifestServiceInfo instances for each service in the stack

getPackageVersion

public String getPackageVersion(String osFamily)

Gets the package version for an OS family

Parameters:

osFamily - the os family

Returns:

the package version, or null if not found

toXml

public String toXml()
             throws Exception

Returns the XML representation of this instance.

Throws:

Exception

getClusterSummary

public ClusterVersionSummary getClusterSummary(Cluster cluster,
                                               AmbariMetaInfo metaInfo)
                                        throws org.apache.ambari.server.AmbariException

Gets a summary for cluster given the version information in this version.

Parameters:

cluster - the cluster by which to iterate services

Returns:

a summary instance

Throws:

org.apache.ambari.server.AmbariException

getMissingDependencies

public Set<String> getMissingDependencies(Cluster cluster,
                                          AmbariMetaInfo metaInfo)
                                   throws org.apache.ambari.server.AmbariException

Gets information about services which cannot be upgraded because the repository does not contain required dependencies. This method will look at the cluster-env/stack_packages structure to see if there are any dependencies listed in the upgrade-dependencies key.

Parameters:

cluster - the cluster (not null).

metaInfo - the metainfo instance

Returns:

a mapping of service name to its missing service dependencies, or an empty map if there are none (never null).

Throws:

org.apache.ambari.server.AmbariException

load

public static VersionDefinitionXml load(URL url)
                                 throws Exception

Parses a URL for a definition XML file into the object graph.

Parameters:

url - the URL to load. Can be a file URL reference also.

Returns:

the definition

Throws:

Exception

load

public static VersionDefinitionXml load(String xml)
                                 throws Exception

Parses an xml string. Used when the xml is in the database.

Parameters:

xml - the xml string

Returns:

the definition

Throws:

Exception

build

public static VersionDefinitionXml build(StackInfo stackInfo)

Builds a Version Definition that is the default for the stack.

This will use all of the services defined on the stack, excluding those which do not advertise a version. If a service doesn't advertise a version, we cannot include it in a generated VDF.

Returns:

the version definition