YARN-11239. Fix CheckStyle.

Author: slfan1989

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-router/src/main/java/org/apache/hadoop/yarn/server/router/RouterAuditLogger.java

@@ -30,7 +30,7 @@
  * Manages Router audit logs.
  * Audit log format is written as key=value pairs. Tab separated.
  */
-public class RouterAuditLogger {
+public final class RouterAuditLogger {
   private static final Logger LOG =
       LoggerFactory.getLogger(RouterAuditLogger.class);
 
@@ -151,6 +151,27 @@ public static void logFailure(String user, String operation, String perm,
     }
   }
 
+  /**
+   * Create a readable and parseable audit log string for a failed event.
+   *
+   * @param user User who made the service request.
+   * @param operation Operation requested by the user.
+   * @param perm Target permissions.
+   * @param target The target on which the operation is being performed.
+   * @param descriptionFormat the description message format string.
+   *
+   * <br><br>
+   * Note that the {@link RouterAuditLogger} uses tabs ('\t') as a key-val
+   * delimiter and hence the value fields should not contains tabs ('\t').
+   */
+  public static void logFailure(String user, String operation, String perm,
+      String target, String descriptionFormat, Object... args) {
+    if (LOG.isInfoEnabled()) {
+      String description = String.format(descriptionFormat, args);
+      LOG.info(createFailureLog(user, operation, perm, target, description, null, null));
+    }
+  }
+
   /**
    * Create a readable and parseable audit log string for a failed event.
    *

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-router/src/main/java/org/apache/hadoop/yarn/server/router/RouterServerUtil.java

@@ -111,6 +111,19 @@ public static void logAndThrowException(String errMsg, Throwable t)
     }
   }
 
+  /**
+   * Throws an exception due to an error.
+   *
+   * @param errMsg the error message
+   * @throws YarnException on failure
+   */
+  @Public
+  @Unstable
+  public static void logAndThrowException(String errMsg) throws YarnException {
+    LOG.error(errMsg);
+    throw new YarnException(errMsg);
+  }
+
   public static <R> R createRequestInterceptorChain(Configuration conf, String pipeLineClassName,
       String interceptorClassName, Class<R> clazz) {
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-router/src/main/java/org/apache/hadoop/yarn/server/router/clientrm/FederationClientInterceptor.java

@@ -806,9 +806,10 @@ public GetApplicationsResponse getApplications(GetApplicationsRequest request)
       throws YarnException, IOException {
     if (request == null) {
       routerMetrics.incrMultipleAppsFailedRetrieved();
+      String msg = "Missing getApplications request.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_APPLICATIONS, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing getApplications request.");
-      RouterServerUtil.logAndThrowException("Missing getApplications request.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg, null);
     }
     long startTime = clock.getTime();
     ClientMethod remoteMethod = new ClientMethod("getApplications",
@@ -831,9 +832,10 @@ public GetClusterMetricsResponse getClusterMetrics(
       GetClusterMetricsRequest request) throws YarnException, IOException {
     if (request == null) {
       routerMetrics.incrGetClusterMetricsFailedRetrieved();
+      String msg = "Missing getApplications request.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_CLUSTERMETRICS, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing getApplications request.");
-      RouterServerUtil.logAndThrowException("Missing getClusterMetrics request.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg, null);
     }
     long startTime = clock.getTime();
     ClientMethod remoteMethod = new ClientMethod("getClusterMetrics",
@@ -913,9 +915,10 @@ public GetClusterNodesResponse getClusterNodes(GetClusterNodesRequest request)
       throws YarnException, IOException {
     if (request == null) {
       routerMetrics.incrClusterNodesFailedRetrieved();
+      String msg = "Missing getClusterNodes request.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_CLUSTERNODES, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing getClusterNodes request.");
-      RouterServerUtil.logAndThrowException("Missing getClusterNodes request.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg, null);
     }
     long startTime = clock.getTime();
     ClientMethod remoteMethod = new ClientMethod("getClusterNodes",
@@ -938,9 +941,10 @@ public GetQueueInfoResponse getQueueInfo(GetQueueInfoRequest request)
       throws YarnException, IOException {
     if (request == null || request.getQueueName() == null) {
       routerMetrics.incrGetQueueInfoFailedRetrieved();
+      String msg = "Missing getQueueInfo request or queueName.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_QUEUEINFO, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing getQueueInfo request or queueName.");
-      RouterServerUtil.logAndThrowException("Missing getQueueInfo request or queueName.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg, null);
     }
 
     long startTime = clock.getTime();
@@ -965,9 +969,10 @@ public GetQueueUserAclsInfoResponse getQueueUserAcls(
       GetQueueUserAclsInfoRequest request) throws YarnException, IOException {
     if(request == null){
       routerMetrics.incrQueueUserAclsFailedRetrieved();
+      String msg = "Missing getQueueUserAcls request.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_QUEUE_USER_ACLS, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing getQueueUserAcls request.");
-      RouterServerUtil.logAndThrowException("Missing getQueueUserAcls request.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg);
     }
     long startTime = clock.getTime();
     ClientMethod remoteMethod = new ClientMethod("getQueueUserAcls",
@@ -991,11 +996,11 @@ public MoveApplicationAcrossQueuesResponse moveApplicationAcrossQueues(
       throws YarnException, IOException {
     if (request == null || request.getApplicationId() == null || request.getTargetQueue() == null) {
       routerMetrics.incrMoveApplicationAcrossQueuesFailedRetrieved();
+      String msg = "Missing moveApplicationAcrossQueues request or " +
+          "applicationId or target queue.";
       RouterAuditLogger.logFailure(user.getShortUserName(), GET_QUEUE_USER_ACLS, UNKNOWN,
-          TARGET_CLIENT_RM_SERVICE, "Missing moveApplicationAcrossQueues request or " +
-          "applicationId or target queue.");
-      RouterServerUtil.logAndThrowException("Missing moveApplicationAcrossQueues request or " +
-          "applicationId or target queue.", null);
+          TARGET_CLIENT_RM_SERVICE, msg);
+      RouterServerUtil.logAndThrowException(msg);
     }
 
     long startTime = clock.getTime();
@@ -1007,8 +1012,8 @@ public MoveApplicationAcrossQueuesResponse moveApplicationAcrossQueues(
           .getApplicationHomeSubCluster(applicationId);
     } catch (YarnException e) {
       routerMetrics.incrMoveApplicationAcrossQueuesFailedRetrieved();
-      RouterServerUtil.logAndThrowException(e, "Application %s does not exist in FederationStateStore.",
-          applicationId);
+      String errMsgFormat = "Application %s does not exist in FederationStateStore.";
+      RouterServerUtil.logAndThrowException(e, errMsgFormat, applicationId);
     }
 
     ApplicationClientProtocol clientRMProxy = getClientRMProxyForSubCluster(subClusterId);