/*
 * *
 *  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.nodemanager.containermanager.runtime;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;

/** An abstraction for various container runtime implementations. Examples
 * include Process Tree, Docker, Appc runtimes etc., These implementations
 * are meant for low-level OS container support - dependencies on
 * higher-level nodemananger constructs should be avoided.
 */

@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface ContainerRuntime {
  /** Prepare a container to be ready for launch */
  void prepareContainer(ContainerRuntimeContext ctx)
      throws ContainerExecutionException;

  /** Launch a container. */
  void launchContainer(ContainerRuntimeContext ctx)
      throws ContainerExecutionException;

  /** Signal a container - request to terminate, status check etc., */
  void signalContainer(ContainerRuntimeContext ctx)
      throws ContainerExecutionException;

  /** Any container cleanup that may be required. */
  void reapContainer(ContainerRuntimeContext ctx)
      throws ContainerExecutionException;
}