hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/ConfigurationMutationACLPolicy.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.resourcemanager.scheduler;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.yarn.server.resourcemanager.RMContext;
import org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo;

/**
 * Interface for determining whether configuration mutations are allowed.
 */
public interface ConfigurationMutationACLPolicy {

  /**
   * Initialize ACL policy with configuration and RMContext.
   * @param conf Configuration to initialize with.
   * @param rmContext rmContext
   */
  void init(Configuration conf, RMContext rmContext);

  /**
   * Check if mutation is allowed.
   * @param user User issuing the request
   * @param confUpdate configurations to be updated
   * @return whether provided mutation is allowed or not
   */
  boolean isMutationAllowed(UserGroupInformation user, SchedConfUpdateInfo
      confUpdate);

}