001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Stable;
023import org.apache.hadoop.yarn.api.ContainerManager;
024import org.apache.hadoop.yarn.api.records.ContainerLaunchContext;
025
026/**
027 * <p>The request sent by the <code>ApplicationMaster</code> to the
028 * <code>NodeManager</code> to <em>start</em> a container.</p>
029 * 
030 * <p>The <code>ApplicationMaster</code> has to provide details such as
031 * allocated resource capability, security tokens (if enabled), command
032 * to be executed to start the container, environment for the process, 
033 * necessary binaries/jar/shared-objects etc. via the 
034 * {@link ContainerLaunchContext}.</p>
035 *
036 * @see ContainerManager#startContainer(StartContainerRequest)
037 */
038@Public
039@Stable
040public interface StartContainerRequest {
041  /**
042   * Get the <code>ContainerLaunchContext</code> for the container to be started
043   * by the <code>NodeManager</code>.
044   * 
045   * @return <code>ContainerLaunchContext</code> for the container to be started
046   *         by the <code>NodeManager</code>
047   */
048  @Public
049  @Stable
050  public abstract ContainerLaunchContext getContainerLaunchContext();
051  
052  /**
053   * Set the <code>ContainerLaunchContext</code> for the container to be started
054   * by the <code>NodeManager</code>
055   * @param context <code>ContainerLaunchContext</code> for the container to be 
056   *                started by the <code>NodeManager</code>
057   */
058  @Public
059  @Stable
060  public abstract void setContainerLaunchContext(ContainerLaunchContext context);
061}