hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/YarnServerBuilderUtils.java

/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.hadoop.yarn.server.utils;

import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.ContainerId;
import org.apache.hadoop.yarn.api.records.impl.pb.ProtoUtils;
import org.apache.hadoop.yarn.factories.RecordFactory;
import org.apache.hadoop.yarn.factory.providers.RecordFactoryProvider;
import org.apache.hadoop.yarn.proto.YarnServerCommonServiceProtos.SystemCredentialsForAppsProto;
import org.apache.hadoop.yarn.server.api.protocolrecords.NodeHeartbeatResponse;
import org.apache.hadoop.yarn.server.api.records.MasterKey;
import org.apache.hadoop.yarn.server.api.records.NodeAction;

/**
 * Server Builder utilities to construct various objects.
 *
 */
public class YarnServerBuilderUtils {

  private static final RecordFactory recordFactory = RecordFactoryProvider
      .getRecordFactory(null);

  public static NodeHeartbeatResponse newNodeHeartbeatResponse(
      NodeAction action, String diagnosticsMessage) {
    NodeHeartbeatResponse response = recordFactory
        .newRecordInstance(NodeHeartbeatResponse.class);
    response.setNodeAction(action);
    response.setDiagnosticsMessage(diagnosticsMessage);
    return response;
  }

  public static NodeHeartbeatResponse newNodeHeartbeatResponse(int responseId,
      NodeAction action, List<ContainerId> containersToCleanUp,
      List<ApplicationId> applicationsToCleanUp,
      MasterKey containerTokenMasterKey, MasterKey nmTokenMasterKey,
      long nextHeartbeatInterval) {
    NodeHeartbeatResponse response = recordFactory
        .newRecordInstance(NodeHeartbeatResponse.class);
    response.setResponseId(responseId);
    response.setNodeAction(action);
    response.setContainerTokenMasterKey(containerTokenMasterKey);
    response.setNMTokenMasterKey(nmTokenMasterKey);
    response.setNextHeartBeatInterval(nextHeartbeatInterval);
    if(containersToCleanUp != null) {
      response.addAllContainersToCleanup(containersToCleanUp);
    }
    if(applicationsToCleanUp != null) {
      response.addAllApplicationsToCleanup(applicationsToCleanUp);
    }
    return response;
  }

  /**
   * Build SystemCredentialsForAppsProto objects.
   *
   * @param applicationId Application ID
   * @param credentials HDFS Tokens
   * @return systemCredentialsForAppsProto
   */
  public static SystemCredentialsForAppsProto newSystemCredentialsForAppsProto(
      ApplicationId applicationId, ByteBuffer credentials) {
    SystemCredentialsForAppsProto systemCredentialsForAppsProto =
        SystemCredentialsForAppsProto.newBuilder()
            .setAppId(ProtoUtils.convertToProtoFormat(applicationId))
            .setCredentialsForApp(ProtoUtils.BYTE_STRING_INTERNER.intern(
                ProtoUtils.convertToProtoFormat(credentials.duplicate())))
            .build();
    return systemCredentialsForAppsProto;
  }

  /**
   * Convert Collection of SystemCredentialsForAppsProto proto objects to a Map
   * of ApplicationId to ByteBuffer.
   *
   * @param systemCredentials List of SystemCredentialsForAppsProto proto
   *          objects
   * @return systemCredentialsForApps Map of Application Id to ByteBuffer
   */
  public static Map<ApplicationId, ByteBuffer> convertFromProtoFormat(
      Collection<SystemCredentialsForAppsProto> systemCredentials) {

    Map<ApplicationId, ByteBuffer> systemCredentialsForApps =
        new HashMap<ApplicationId, ByteBuffer>(systemCredentials.size());
    for (SystemCredentialsForAppsProto proto : systemCredentials) {
      systemCredentialsForApps.put(
          ProtoUtils.convertFromProtoFormat(proto.getAppId()),
          ProtoUtils.convertFromProtoFormat(proto.getCredentialsForApp()));
    }
    return systemCredentialsForApps;
  }

  /**
   * Convert Map of Application Id to ByteBuffer to Collection of
   * SystemCredentialsForAppsProto proto objects.
   *
   * @param systemCredentialsForApps Map of Application Id to ByteBuffer
   * @return systemCredentials List of SystemCredentialsForAppsProto proto
   *         objects
   */
  public static List<SystemCredentialsForAppsProto> convertToProtoFormat(
      Map<ApplicationId, ByteBuffer> systemCredentialsForApps) {
    List<SystemCredentialsForAppsProto> systemCredentials =
        new ArrayList<SystemCredentialsForAppsProto>(
            systemCredentialsForApps.size());
    for (Map.Entry<ApplicationId, ByteBuffer> entry : systemCredentialsForApps
        .entrySet()) {
      SystemCredentialsForAppsProto proto =
          newSystemCredentialsForAppsProto(entry.getKey(), entry.getValue());
      systemCredentials.add(proto);
    }
    return systemCredentials;
  }
}