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    
019    package org.apache.hadoop.yarn.api.records;
020    
021    import org.apache.hadoop.classification.InterfaceAudience.Public;
022    import org.apache.hadoop.classification.InterfaceStability.Stable;
023    import org.apache.hadoop.yarn.api.AMRMProtocol;
024    import org.apache.hadoop.yarn.api.ContainerManager;
025    
026    /**
027     * <p><code>ContainerToken</code> is the security token used by the framework
028     * to verify authenticity of any <code>Container</code>.</p>
029     *
030     * <p>The <code>ResourceManager</code>, on container allocation provides a
031     * secure token which is verified by the <code>NodeManager</code> on 
032     * container launch.</p>
033     * 
034     * <p>Applications do not need to care about <code>ContainerToken</code>, they
035     * are transparently handled by the framework - the allocated 
036     * <code>Container</code> includes the <code>ContainerToken</code>.</p>
037     * 
038     * @see AMRMProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
039     * @see ContainerManager#startContainer(org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest)
040     */
041    @Public
042    @Stable
043    public interface ContainerToken extends Token {}