Package org.apache.hadoop.yarn.server.router

Class RouterServerUtil

java.lang.Object

org.apache.hadoop.yarn.server.router.RouterServerUtil

@Private
@Unstable
public final class RouterServerUtil
extends java.lang.Object

Common utility methods used by the Router server.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
static void	checkAppSubmissionContext(org.apache.hadoop.yarn.api.records.impl.pb.ApplicationSubmissionContextPBImpl appContext, org.apache.hadoop.conf.Configuration conf)	Checks if the ApplicationSubmissionContext submitted with the application is valid.
static boolean	checkPolicyManagerValid(java.lang.String policyManager, java.util.List<java.lang.String> supportWeightList)
static org.apache.hadoop.yarn.api.records.ReservationDefinition	convertReservationDefinition(org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationDefinitionInfo definitionInfo)	Convert ReservationDefinitionInfo to ReservationDefinition.
static <R> R	createRequestInterceptorChain(org.apache.hadoop.conf.Configuration conf, java.lang.String pipeLineClassName, java.lang.String interceptorClassName, java.lang.Class<R> clazz)
static java.lang.String	getRenewerForToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier> token)
static org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext	getTrimmedAppSubmissionContext(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext actualContext)	Get trimmed version of ApplicationSubmissionContext to be saved to Federation State Store.
static boolean	isAllowedDelegationTokenOp()
static boolean	isRouterWebProxyEnable(org.apache.hadoop.conf.Configuration conf)
static java.lang.RuntimeException	logAndReturnRunTimeException(java.lang.String errMsgFormat, java.lang.Object... args)	Throws an RunTimeException due to an error.
static java.lang.RuntimeException	logAndReturnRunTimeException(java.lang.Throwable t, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an RunTimeException due to an error.
static org.apache.hadoop.yarn.exceptions.YarnRuntimeException	logAndReturnYarnRunTimeException(java.lang.Throwable t, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an YarnRuntimeException due to an error.
static void	logAndThrowException(java.lang.String errMsg)	Throws an exception due to an error.
static void	logAndThrowException(java.lang.String errMsg, java.lang.Throwable t)	Throws an exception due to an error.
static void	logAndThrowException(java.lang.Throwable t, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an exception due to an error.
static void	logAndThrowIOException(java.lang.String errMsg, java.lang.Throwable t)	Throws an IOException due to an error.
static void	logAndThrowIOException(java.lang.Throwable t, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an IOException due to an error.
static void	logAndThrowRunTimeException(java.lang.String errMsg, java.lang.Throwable t)	Throws an RunTimeException due to an error.
static void	logAndThrowRunTimeException(java.lang.Throwable t, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an RunTimeException due to an error.
static org.apache.hadoop.security.UserGroupInformation	setupUser(java.lang.String userName)	Set User information.
static void	validateApplicationAttemptId(java.lang.String appAttemptId)	Check appAttemptId is accurate.
static void	validateApplicationId(java.lang.String applicationId)	Check applicationId is accurate.
static void	validateContainerId(java.lang.String containerId)	Check containerId is accurate.
static void	validateReservationId(java.lang.String reservationId)	Check reservationId is accurate.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Method Detail

logAndThrowException

@Public
@Unstable
public static void logAndThrowException(java.lang.Throwable t,
                                        java.lang.String errMsgFormat,
                                        java.lang.Object... args)
                                 throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an exception due to an error.

Parameters:

t - the throwable raised in the called class.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowException

@Public
@Unstable
public static void logAndThrowException(java.lang.String errMsg,
                                        java.lang.Throwable t)
                                 throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an exception due to an error.

Parameters:

errMsg - the error message

t - the throwable raised in the called class.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowException

@Public
@Unstable
public static void logAndThrowException(java.lang.String errMsg)
                                 throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an exception due to an error.

Parameters:

errMsg - the error message

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

createRequestInterceptorChain

public static <R> R createRequestInterceptorChain(org.apache.hadoop.conf.Configuration conf,
                                                  java.lang.String pipeLineClassName,
                                                  java.lang.String interceptorClassName,
                                                  java.lang.Class<R> clazz)

logAndThrowIOException

@Public
@Unstable
public static void logAndThrowIOException(java.lang.String errMsg,
                                          java.lang.Throwable t)
                                   throws java.io.IOException

Throws an IOException due to an error.

Parameters:

errMsg - the error message

t - the throwable raised in the called class.

Throws:

java.io.IOException - on failure

logAndThrowIOException

@Public
@Unstable
public static void logAndThrowIOException(java.lang.Throwable t,
                                          java.lang.String errMsgFormat,
                                          java.lang.Object... args)
                                   throws java.io.IOException

Throws an IOException due to an error.

Parameters:

t - the throwable raised in the called class.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

java.io.IOException - on failure

logAndThrowRunTimeException

@Public
@Unstable
public static void logAndThrowRunTimeException(java.lang.String errMsg,
                                               java.lang.Throwable t)
                                        throws java.lang.RuntimeException

Throws an RunTimeException due to an error.

Parameters:

errMsg - the error message

t - the throwable raised in the called class.

Throws:

java.lang.RuntimeException - on failure

logAndThrowRunTimeException

@Public
@Unstable
public static void logAndThrowRunTimeException(java.lang.Throwable t,
                                               java.lang.String errMsgFormat,
                                               java.lang.Object... args)
                                        throws java.lang.RuntimeException

Throws an RunTimeException due to an error.

Parameters:

t - the throwable raised in the called class.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

java.lang.RuntimeException - on failure

logAndReturnRunTimeException

@Public
@Unstable
public static java.lang.RuntimeException logAndReturnRunTimeException(java.lang.Throwable t,
                                                                      java.lang.String errMsgFormat,
                                                                      java.lang.Object... args)

Throws an RunTimeException due to an error.

Parameters:

t - the throwable raised in the called class.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Returns:

RuntimeException

logAndReturnRunTimeException

@Public
@Unstable
public static java.lang.RuntimeException logAndReturnRunTimeException(java.lang.String errMsgFormat,
                                                                      java.lang.Object... args)

Throws an RunTimeException due to an error.

Parameters:

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Returns:

RuntimeException

logAndReturnYarnRunTimeException

@Public
@Unstable
public static org.apache.hadoop.yarn.exceptions.YarnRuntimeException logAndReturnYarnRunTimeException(java.lang.Throwable t,
                                                                                                      java.lang.String errMsgFormat,
                                                                                                      java.lang.Object... args)

Throws an YarnRuntimeException due to an error.

Parameters:

t - the throwable raised in the called class.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Returns:

YarnRuntimeException

validateApplicationId

@Public
@Unstable
public static void validateApplicationId(java.lang.String applicationId)
                                  throws java.lang.IllegalArgumentException

Check applicationId is accurate. We need to ensure that applicationId cannot be empty and can be converted to ApplicationId object normally.

Parameters:

applicationId - applicationId of type string

Throws:

java.lang.IllegalArgumentException - If the format of the applicationId is not accurate, an IllegalArgumentException needs to be thrown.

validateApplicationAttemptId

@Public
@Unstable
public static void validateApplicationAttemptId(java.lang.String appAttemptId)
                                         throws java.lang.IllegalArgumentException

Check appAttemptId is accurate. We need to ensure that appAttemptId cannot be empty and can be converted to ApplicationAttemptId object normally.

Parameters:

appAttemptId - appAttemptId of type string.

Throws:

java.lang.IllegalArgumentException - If the format of the appAttemptId is not accurate, an IllegalArgumentException needs to be thrown.

validateContainerId

@Public
@Unstable
public static void validateContainerId(java.lang.String containerId)
                                throws java.lang.IllegalArgumentException

Check containerId is accurate. We need to ensure that containerId cannot be empty and can be converted to ContainerId object normally.

Parameters:

containerId - containerId of type string.

Throws:

java.lang.IllegalArgumentException - If the format of the appAttemptId is not accurate, an IllegalArgumentException needs to be thrown.

isAllowedDelegationTokenOp

public static boolean isAllowedDelegationTokenOp()
                                          throws java.io.IOException

Throws:

java.io.IOException

getRenewerForToken

public static java.lang.String getRenewerForToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier> token)
                                           throws java.io.IOException

Throws:

java.io.IOException

setupUser

public static org.apache.hadoop.security.UserGroupInformation setupUser(java.lang.String userName)

Set User information. If the username is empty, we will use the Yarn Router user directly. Do not create a proxy user if userName matches the userName on current UGI.

Parameters:

userName - userName.

Returns:

UserGroupInformation.

validateReservationId

@Public
@Unstable
public static void validateReservationId(java.lang.String reservationId)
                                  throws java.lang.IllegalArgumentException

Check reservationId is accurate. We need to ensure that reservationId cannot be empty and can be converted to ReservationId object normally.

Parameters:

reservationId - reservationId.

Throws:

java.lang.IllegalArgumentException - If the format of the reservationId is not accurate, an IllegalArgumentException needs to be thrown.

convertReservationDefinition

public static org.apache.hadoop.yarn.api.records.ReservationDefinition convertReservationDefinition(org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationDefinitionInfo definitionInfo)

Convert ReservationDefinitionInfo to ReservationDefinition.

Parameters:

definitionInfo - ReservationDefinitionInfo Object.

Returns:

ReservationDefinition.

checkAppSubmissionContext

@Public
@Unstable
public static void checkAppSubmissionContext(org.apache.hadoop.yarn.api.records.impl.pb.ApplicationSubmissionContextPBImpl appContext,
                                             org.apache.hadoop.conf.Configuration conf)
                                      throws java.io.IOException,
                                             org.apache.hadoop.yarn.exceptions.YarnException

Checks if the ApplicationSubmissionContext submitted with the application is valid. Current checks: - if its size is within limits.

Parameters:

appContext - the app context to check.

conf - Configuration.

Throws:

java.io.IOException - if an IO error occurred.

org.apache.hadoop.yarn.exceptions.YarnException - yarn exception.

getTrimmedAppSubmissionContext

@Private
@Unstable
public static org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext getTrimmedAppSubmissionContext(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext actualContext)

Get trimmed version of ApplicationSubmissionContext to be saved to Federation State Store.

Parameters:

actualContext - actual ApplicationSubmissionContext.

Returns:

trimmed ApplicationSubmissionContext.

isRouterWebProxyEnable

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

checkPolicyManagerValid

public static boolean checkPolicyManagerValid(java.lang.String policyManager,
                                              java.util.List<java.lang.String> supportWeightList)
                                       throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException