Package org.apache.hadoop.yarn.client.util

Class YarnClientUtils

java.lang.Object

org.apache.hadoop.yarn.client.util.YarnClientUtils

public abstract class YarnClientUtils
extends java.lang.Object

This class is a container for utility methods that are useful when creating YARN clients.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
YarnClientUtils()

Method Summary

Modifier and Type	Method	Description
static java.util.List<org.apache.hadoop.yarn.api.records.NodeLabel>	buildNodeLabelsFromStr(java.lang.String args)	Creates node labels from string
static java.lang.String	generateToken(java.lang.String server)	Generate SPNEGO challenge request token.
static java.lang.String	getRmPrincipal(java.lang.String rmPrincipal, org.apache.hadoop.conf.Configuration conf)	Perform the _HOST replacement in the principal, Returning the result.
static java.lang.String	getRmPrincipal(org.apache.hadoop.conf.Configuration conf)	Look up and return the resource manager's principal.
static boolean	isYarnFederationEnabled(org.apache.hadoop.conf.Configuration conf)

Methods inherited from class java.lang.Object

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

Field Detail

NO_LABEL_ERR_MSG

public static final java.lang.String NO_LABEL_ERR_MSG

See Also:

Constant Field Values

Constructor Detail

YarnClientUtils

public YarnClientUtils()

Method Detail

getRmPrincipal

public static java.lang.String getRmPrincipal(org.apache.hadoop.conf.Configuration conf)
                                       throws java.io.IOException

Look up and return the resource manager's principal. This method automatically does the _HOST replacement in the principal and correctly handles HA resource manager configurations.

Parameters:

conf - the Configuration file from which to read the principal

Returns:

the resource manager's principal string or null if the YarnConfiguration.RM_PRINCIPAL property is not set in the conf parameter

Throws:

java.io.IOException - thrown if there's an error replacing the host name

getRmPrincipal

public static java.lang.String getRmPrincipal(java.lang.String rmPrincipal,
                                              org.apache.hadoop.conf.Configuration conf)
                                       throws java.io.IOException

Perform the _HOST replacement in the principal, Returning the result. Correctly handles HA resource manager configurations.

Parameters:

rmPrincipal - the principal string to prepare

conf - the configuration

Returns:

the prepared principal string

Throws:

java.io.IOException - thrown if there's an error replacing the host name

buildNodeLabelsFromStr

public static java.util.List<org.apache.hadoop.yarn.api.records.NodeLabel> buildNodeLabelsFromStr(java.lang.String args)

Creates node labels from string

Parameters:

args - nodelabels string to be parsed

Returns:

list of node labels

generateToken

public static java.lang.String generateToken(java.lang.String server)
                                      throws java.io.IOException,
                                             java.lang.InterruptedException

Generate SPNEGO challenge request token.

Parameters:

server - - hostname to contact

Returns:

SPNEGO token challenge

Throws:

java.io.IOException - thrown if doAs failed

java.lang.InterruptedException - thrown if doAs is interrupted

isYarnFederationEnabled

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