org.apache.ambari.server.checks

Class UpgradeCheckRegistry

java.lang.Object

org.apache.ambari.server.checks.UpgradeCheckRegistry

public class UpgradeCheckRegistry
extends Object

The UpgradeCheckRegistry contains the ordered list of all pre-upgrade checks. This will order the checks according to PreUpgradeCheckComparator.

There are two types of checks which can be loaded into this registry:

• Built-in: checks which ship with Ambari
• Plug-in: checks which are specified in the upgrade pack for a stack, and either come from Ambari's checks or from the library classpath of the stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpgradeCheckRegistry.PluginUpgradeChecks Encapsulates information about which plugins could and could not be loaded from a stack.

Constructor Summary

Constructors

Constructor and Description
UpgradeCheckRegistry()

Method Summary

Modifier and Type	Method and Description
List<org.apache.ambari.spi.upgrade.UpgradeCheck>	getBuiltInUpgradeChecks() Gets a list of all of the built-in upgrade checks.
Set<String>	getFailedPluginClassNames() Gets all of the upgrade check classes defined in upgrade packs which were not able to be loaded and instantiated.
List<org.apache.ambari.spi.upgrade.UpgradeCheck>	getFilteredUpgradeChecks(UpgradePack upgradePack) Gets the ordered upgrade checks which should execute for the specified upgrade pack.
void	register(org.apache.ambari.spi.upgrade.UpgradeCheck upgradeCheck) Register an upgrade check.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeCheckRegistry

public UpgradeCheckRegistry()

Method Detail

register

public void register(org.apache.ambari.spi.upgrade.UpgradeCheck upgradeCheck)

Register an upgrade check.

Parameters:

upgradeCheck - the check to register (not null).

getBuiltInUpgradeChecks

public List<org.apache.ambari.spi.upgrade.UpgradeCheck> getBuiltInUpgradeChecks()

Gets a list of all of the built-in upgrade checks.

Returns:

getFilteredUpgradeChecks

public List<org.apache.ambari.spi.upgrade.UpgradeCheck> getFilteredUpgradeChecks(UpgradePack upgradePack)
                                                                          throws org.apache.ambari.server.AmbariException

Gets the ordered upgrade checks which should execute for the specified upgrade pack. This list of checks will include required built-in checks from Ambari and plugin checks loaded from the upgrade pack.

This collection of upgrade checks will be further scrutinized via CheckQualifications to determine if they indeed need to run by the CheckHelper.

Parameters:

upgradePack - Upgrade pack object with the list of required checks to be included

Returns:

Throws:

org.apache.ambari.server.AmbariException

getFailedPluginClassNames

public Set<String> getFailedPluginClassNames()

Gets all of the upgrade check classes defined in upgrade packs which were not able to be loaded and instantiated.

Returns:

all of the failed upgrade check classes.