org.apache.ambari.server.stack.upgrade

Class UpgradePack

java.lang.Object

org.apache.ambari.server.stack.upgrade.UpgradePack

public class UpgradePack
extends Object

Represents an upgrade pack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpgradePack.IntermediateStack An intermediate stack definition in upgrade/upgrade-path/intermediate-stack path
static class	UpgradePack.OrderService A service definition that holds a list of components in the 'order' element.
static class	UpgradePack.PrerequisiteCheckConfig Prerequisite checks configuration
static class	UpgradePack.PrerequisiteCheckProperties Config properties for a specific prerequisite check.
static class	UpgradePack.PrerequisiteChecks Container class to specify list of additional prerequisite checks to run in addition to the required prerequisite checks and configuration properties for all prerequisite checks
static class	UpgradePack.PrerequisiteProperty Prerequisite check config property
static class	UpgradePack.ProcessingComponent A component definition in the 'processing/service' path.
static class	UpgradePack.ProcessingService A service definition in the 'processing' element.

Constructor Summary

Constructors

Constructor and Description
UpgradePack()

Method Summary

Modifier and Type	Method and Description
boolean	anyGroupTaskMatch(Predicate<Task> taskPredicate)
boolean	canBeApplied(String targetVersion)
boolean	equals(Object object)
Map<String,AddComponentTask>	getAddComponentTasks() Gets a mapping of SERVICE/COMPONENT to AddComponentTask for this upgrade pack.
List<Grouping>	getAllGroups()
List<Grouping>	getGroups(Direction direction) Gets the groups defined for the upgrade pack.
List<UpgradePack.IntermediateStack>	getIntermediateStacks() Gets a list of stacks which are between the current stack version and the target stack version inclusive.
String	getName()
String	getOrchestrationOptions()
StackId	getOwnerStackId()
UpgradePack.PrerequisiteCheckConfig	getPrerequisiteCheckConfig()
List<String>	getPrerequisiteChecks()
String	getSource()
String	getSourceStack()
String	getTarget()
String	getTargetStack()
Map<String,Map<String,UpgradePack.ProcessingComponent>>	getTasks() Gets the tasks by which services and components should be upgraded.
org.apache.ambari.spi.upgrade.UpgradeType	getType()
int	hashCode()
boolean	isAllTarget()
boolean	isComponentFailureAutoSkipped() Gets whether skippable components that failed are automatically skipped.
boolean	isDowngradeAllowed()
boolean	isServiceCheckFailureAutoSkipped() Gets whether skippable service checks that failed are automatically skipped.
void	mergePrerequisiteChecks(UpgradePack pack) Merges the prerequisite checks section of the upgrade xml with the prerequisite checks from a service's upgrade xml.
void	mergeProcessing(UpgradePack pack) Merges the processing section of the upgrade xml with the processing section from a service's upgrade xml.
void	setName(String name)
void	setOwnerStackId(StackId stackId) Sets the stack id that owns this upgrade pack.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradePack

public UpgradePack()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getName

public String getName()

setName

public void setName(String name)

getSource

public String getSource()

Returns:

the source version for the upgrade pack

getSourceStack

public String getSourceStack()

Returns:

the source stack

getTarget

public String getTarget()

Returns:

the target version for the upgrade pack

getTargetStack

public String getTargetStack()

Returns:

the target stack

getType

public org.apache.ambari.spi.upgrade.UpgradeType getType()

Returns:

the type of upgrade, e.g., "ROLLING" or "NON_ROLLING"

getPrerequisiteChecks

public List<String> getPrerequisiteChecks()

Returns:

the preCheck name, e.g. "CheckDescription"

getPrerequisiteCheckConfig

public UpgradePack.PrerequisiteCheckConfig getPrerequisiteCheckConfig()

Returns:

the prerequisite check configuration

mergePrerequisiteChecks

public void mergePrerequisiteChecks(UpgradePack pack)

Merges the prerequisite checks section of the upgrade xml with the prerequisite checks from a service's upgrade xml. These are added to the end of the current list of checks.

Parameters:

pack - the service's upgrade pack

mergeProcessing

public void mergeProcessing(UpgradePack pack)

Merges the processing section of the upgrade xml with the processing section from a service's upgrade xml. These are added to the end of the current list of services.

Parameters:

pack - the service's upgrade pack

getIntermediateStacks

public List<UpgradePack.IntermediateStack> getIntermediateStacks()

Gets a list of stacks which are between the current stack version and the target stack version inclusive. For example, if upgrading from HDP-2.2 to HDP-2.4, this should include HDP-2.3 and HDP-2.4.

This method is used to combine the correct configuration packs for a specific upgrade from AmbariMetaInfo.getConfigUpgradePack(String, String).

Returns:

a list of intermediate stacks (target stack inclusive) or null if none.

isComponentFailureAutoSkipped

public boolean isComponentFailureAutoSkipped()

Gets whether skippable components that failed are automatically skipped.

Returns:

the skipComponentFailures

isServiceCheckFailureAutoSkipped

public boolean isServiceCheckFailureAutoSkipped()

Gets whether skippable service checks that failed are automatically skipped.

Returns:

the skipServiceCheckFailures

getAllGroups

public List<Grouping> getAllGroups()

getGroups

public List<Grouping> getGroups(Direction direction)

Gets the groups defined for the upgrade pack. If a direction is defined for a group, it must match the supplied direction to be returned

Parameters:

direction - the direction to return the ordered groups

Returns:

the list of groups

isDowngradeAllowed

public boolean isDowngradeAllowed()

Returns:

true if upgrade pack supports downgrade or false if not.

canBeApplied

public boolean canBeApplied(String targetVersion)

getTasks

public Map<String,Map<String,UpgradePack.ProcessingComponent>> getTasks()

Gets the tasks by which services and components should be upgraded.

Returns:

a map of service_name -> map(component_name -> process).

getAddComponentTasks

public Map<String,AddComponentTask> getAddComponentTasks()

Gets a mapping of SERVICE/COMPONENT to AddComponentTask for this upgrade pack.

Returns:

isAllTarget

public boolean isAllTarget()

Returns:

true if the upgrade targets any version or stack. Both target and targetStack must equal "*"

anyGroupTaskMatch

public boolean anyGroupTaskMatch(Predicate<Task> taskPredicate)

Returns:

true if this upgrade pack contains a group with a task that matches the given predicate

setOwnerStackId

public void setOwnerStackId(StackId stackId)

Sets the stack id that owns this upgrade pack. This may be set only once.

Parameters:

stackId - the owner stack id

getOwnerStackId

public StackId getOwnerStackId()

Returns:

the stack id that owns this upgrade pack.

getOrchestrationOptions

public String getOrchestrationOptions()

Returns:

the class name used for orchestration options