org.apache.ambari.server.checks

Class ClusterCheck

java.lang.Object

org.apache.ambari.server.checks.ClusterCheck

All Implemented Interfaces:

org.apache.ambari.spi.upgrade.UpgradeCheck

Direct Known Subclasses:

AmbariMetricsHadoopSinkVersionCompatibilityCheck, AutoStartDisabledCheck, ComponentsExistInRepoCheck, ComponentsInstallationCheck, ConfigurationMergeCheck, HardcodedStackVersionPropertiesCheck, HealthCheck, HostMaintenanceModeCheck, HostsHeartbeatCheck, HostsMasterMaintenanceCheck, HostsRepositoryVersionCheck, InstallPackagesCheck, KerberosAdminPersistedCredentialCheck, LZOCheck, MissingOsInRepoVersionCheck, PluginChecksLoadedCheck, PreviousUpgradeCompleted, RequiredServicesInRepositoryCheck, ServiceCheckValidityCheck, ServicePresenceCheck, ServicesMaintenanceModeCheck, ServicesUpCheck, VersionMismatchCheck

public abstract class ClusterCheck
extends Object
implements org.apache.ambari.spi.upgrade.UpgradeCheck

A base implementation of UpgradeCheck which offers injected helpers and access to information about repositories and the cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.inject.Provider<Clusters>	clustersProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusterCheck(org.apache.ambari.spi.upgrade.UpgradeCheckDescription description) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	formatEntityList(LinkedHashSet<String> entities) Formats lists of given entities to human readable form: [entity1] -> {entity1} {noun} [entity1, entity2] -> {entity1} and {entity2} {noun}s [entity1, entity2, entity3] -> {entity1}, {entity2} and {entity3} {noun}s The noun for the entities is taken from check type, it may be cluster, service or host.
Set<String>	getApplicableServices() Gets the set of services that this check is associated with.
org.apache.ambari.spi.upgrade.UpgradeCheckDescription	getCheckDescription()
org.apache.ambari.spi.upgrade.UpgradeCheckDescription	getDescription() Gets the description of the check.
protected String	getFailReason(String key, org.apache.ambari.spi.upgrade.UpgradeCheckResult upgradeCheckResult, org.apache.ambari.spi.upgrade.UpgradeCheckRequest request) Gets the fail reason
protected String	getFailReason(org.apache.ambari.spi.upgrade.UpgradeCheckResult upgradeCheckResult, org.apache.ambari.spi.upgrade.UpgradeCheckRequest request) Gets the default fail reason
protected String	getProperty(org.apache.ambari.spi.upgrade.UpgradeCheckRequest request, String configType, String propertyName) Gets a cluster configuration property if it exists, or null otherwise.
List<org.apache.ambari.spi.upgrade.CheckQualification>	getQualifications() Gets any additional qualifications which an upgrade check should run in order to determine if it's applicable to the upgrade.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.spi.upgrade.UpgradeCheck

perform

Field Detail

clustersProvider

@Inject
protected com.google.inject.Provider<Clusters> clustersProvider

Constructor Detail

ClusterCheck

protected ClusterCheck(org.apache.ambari.spi.upgrade.UpgradeCheckDescription description)

Constructor.

Parameters:

description - description

Method Detail

getCheckDescription

public org.apache.ambari.spi.upgrade.UpgradeCheckDescription getCheckDescription()

Specified by:

getCheckDescription in interface org.apache.ambari.spi.upgrade.UpgradeCheck

getApplicableServices

public Set<String> getApplicableServices()

Gets the set of services that this check is associated with. If the check is not associated with a particular service, then this should be an empty set.

Specified by:

getApplicableServices in interface org.apache.ambari.spi.upgrade.UpgradeCheck

Returns:

a set of services which will determine whether this check is applicable.

getQualifications

public List<org.apache.ambari.spi.upgrade.CheckQualification> getQualifications()

Gets any additional qualifications which an upgrade check should run in order to determine if it's applicable to the upgrade.

Specified by:

getQualifications in interface org.apache.ambari.spi.upgrade.UpgradeCheck

Returns:

a list of qualifications, or an empty list.

getDescription

public org.apache.ambari.spi.upgrade.UpgradeCheckDescription getDescription()

Gets the description of the check.

Returns:

the description (not null).

getFailReason

protected String getFailReason(org.apache.ambari.spi.upgrade.UpgradeCheckResult upgradeCheckResult,
                               org.apache.ambari.spi.upgrade.UpgradeCheckRequest request)
                        throws org.apache.ambari.server.AmbariException

Gets the default fail reason

Parameters:

upgradeCheckResult - the check being performed

request - the request

Returns:

the failure string

Throws:

org.apache.ambari.server.AmbariException

getProperty

protected String getProperty(org.apache.ambari.spi.upgrade.UpgradeCheckRequest request,
                             String configType,
                             String propertyName)
                      throws org.apache.ambari.server.AmbariException

Gets a cluster configuration property if it exists, or null otherwise.

Parameters:

request - the request (not null).

configType - the configuration type, such as hdfs-site (not null).

propertyName - the name of the property (not null).

Returns:

the property value or null if not found.

Throws:

org.apache.ambari.server.AmbariException

getFailReason

protected String getFailReason(String key,
                               org.apache.ambari.spi.upgrade.UpgradeCheckResult upgradeCheckResult,
                               org.apache.ambari.spi.upgrade.UpgradeCheckRequest request)
                        throws org.apache.ambari.server.AmbariException

Gets the fail reason

Parameters:

key - the failure text key

UpgradeCheck - the check being performed

request - the request

Returns:

the failure string

Throws:

org.apache.ambari.server.AmbariException

formatEntityList

protected String formatEntityList(LinkedHashSet<String> entities)

Formats lists of given entities to human readable form: [entity1] -> {entity1} {noun} [entity1, entity2] -> {entity1} and {entity2} {noun}s [entity1, entity2, entity3] -> {entity1}, {entity2} and {entity3} {noun}s The noun for the entities is taken from check type, it may be cluster, service or host.

Parameters:

entities - list of entities to format

Returns:

formatted entity list