Package org.apache.hadoop.yarn.conf

Class HAUtil

java.lang.Object

org.apache.hadoop.yarn.conf.HAUtil

@Private
public class HAUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BAD_CONFIG_MESSAGE_PREFIX

Method Summary

Modifier and Type	Method	Description
static java.lang.String	addSuffix(java.lang.String key, java.lang.String suffix)	Add non-empty and non-null suffix to a key.
static java.lang.String	getConfValueForRMInstance(java.lang.String prefix, java.lang.String defaultValue, org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getConfValueForRMInstance(java.lang.String prefix, org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getCurrentRMAddress(org.apache.hadoop.conf.Configuration conf, java.lang.String address, java.lang.String defaultAddr, int defaultPort)
static java.lang.String	getRMHAId(org.apache.hadoop.conf.Configuration conf)
static java.util.Collection<java.lang.String>	getRMHAIds(org.apache.hadoop.conf.Configuration conf)
static boolean	isAutomaticFailoverEmbedded(org.apache.hadoop.conf.Configuration conf)
static boolean	isAutomaticFailoverEnabled(org.apache.hadoop.conf.Configuration conf)
static boolean	isAutomaticFailoverEnabledAndEmbedded(org.apache.hadoop.conf.Configuration conf)
static boolean	isCustomRMHAEnabled(org.apache.hadoop.conf.Configuration conf)	Returns true if a Custom Resource Manager scheme HA is configured.
static boolean	isFederationEnabled(org.apache.hadoop.conf.Configuration conf)	Returns true if Federation is configured.
static boolean	isFederationFailoverEnabled(org.apache.hadoop.conf.Configuration conf)	Returns true if RM failover is enabled in a Federation setting.
static boolean	isHAEnabled(org.apache.hadoop.conf.Configuration conf)	Returns true if Resource Manager HA is configured.
static void	verifyAndSetAllServiceAddresses(org.apache.hadoop.conf.Configuration conf)
static void	verifyAndSetConfiguration(org.apache.hadoop.conf.Configuration conf)	Verify configuration for Resource Manager HA.

Methods inherited from class java.lang.Object

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

Field Detail

BAD_CONFIG_MESSAGE_PREFIX

@VisibleForTesting
public static final java.lang.String BAD_CONFIG_MESSAGE_PREFIX

See Also:

Constant Field Values

Method Detail

isFederationEnabled

public static boolean isFederationEnabled(org.apache.hadoop.conf.Configuration conf)

Returns true if Federation is configured.

Parameters:

conf - Configuration

Returns:

true if federation is configured in the configuration; else false.

isFederationFailoverEnabled

public static boolean isFederationFailoverEnabled(org.apache.hadoop.conf.Configuration conf)

Returns true if RM failover is enabled in a Federation setting.

Parameters:

conf - Configuration

Returns:

if RM failover is enabled in conjunction with Federation in the configuration; else false.

isHAEnabled

public static boolean isHAEnabled(org.apache.hadoop.conf.Configuration conf)

Returns true if Resource Manager HA is configured.

Parameters:

conf - Configuration

Returns:

true if HA is configured in the configuration; else false.

isCustomRMHAEnabled

public static boolean isCustomRMHAEnabled(org.apache.hadoop.conf.Configuration conf)

Returns true if a Custom Resource Manager scheme HA is configured.

Parameters:

conf - Configuration

Returns:

true if a Custom RM HA scheme is configured in the configuration; else false.

getCurrentRMAddress

public static java.lang.String getCurrentRMAddress(org.apache.hadoop.conf.Configuration conf,
                                                   java.lang.String address,
                                                   java.lang.String defaultAddr,
                                                   int defaultPort)

isAutomaticFailoverEnabled

public static boolean isAutomaticFailoverEnabled(org.apache.hadoop.conf.Configuration conf)

isAutomaticFailoverEnabledAndEmbedded

public static boolean isAutomaticFailoverEnabledAndEmbedded(org.apache.hadoop.conf.Configuration conf)

isAutomaticFailoverEmbedded

public static boolean isAutomaticFailoverEmbedded(org.apache.hadoop.conf.Configuration conf)

verifyAndSetConfiguration

public static void verifyAndSetConfiguration(org.apache.hadoop.conf.Configuration conf)
                                      throws YarnRuntimeException

Verify configuration for Resource Manager HA.

Parameters:

conf - Configuration

Throws:

YarnRuntimeException - thrown by a remote service.

verifyAndSetAllServiceAddresses

public static void verifyAndSetAllServiceAddresses(org.apache.hadoop.conf.Configuration conf)

getRMHAIds

public static java.util.Collection<java.lang.String> getRMHAIds(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf - Configuration. Please use getRMHAIds to check.

Returns:

RM Ids on success

getRMHAId

public static java.lang.String getRMHAId(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf - Configuration. Please use verifyAndSetRMHAId to check.

Returns:

RM Id on success

getConfValueForRMInstance

public static java.lang.String getConfValueForRMInstance(java.lang.String prefix,
                                                         org.apache.hadoop.conf.Configuration conf)

getConfValueForRMInstance

public static java.lang.String getConfValueForRMInstance(java.lang.String prefix,
                                                         java.lang.String defaultValue,
                                                         org.apache.hadoop.conf.Configuration conf)

addSuffix

public static java.lang.String addSuffix(java.lang.String key,
                                         java.lang.String suffix)

Add non-empty and non-null suffix to a key.

Parameters:

key - key.

suffix - suffix.

Returns:

the suffixed key