<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT>     * or more contributor license agreements.  See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT>     * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT>     * regarding copyright ownership.  The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT>     * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT>     * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT>     * with the License.  You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT>     *<a name="line.11"></a>
<FONT color="green">012</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT>     * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT>     * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT>     */<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    package org.apache.hadoop.yarn.api.protocolrecords;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import java.nio.ByteBuffer;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Map;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.hadoop.classification.InterfaceAudience.Public;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.hadoop.classification.InterfaceStability.Stable;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.hadoop.yarn.api.ContainerManager;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    /**<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;p&gt;The response sent by the &lt;code&gt;NodeManager&lt;/code&gt; to the <a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;code&gt;ApplicationMaster&lt;/code&gt; when asked to &lt;em&gt;start&lt;/em&gt; an<a name="line.30"></a>
<FONT color="green">031</FONT>     * allocated container.&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * <a name="line.32"></a>
<FONT color="green">033</FONT>     * @see ContainerManager#startContainer(StartContainerRequest)<a name="line.33"></a>
<FONT color="green">034</FONT>     */<a name="line.34"></a>
<FONT color="green">035</FONT>    @Public<a name="line.35"></a>
<FONT color="green">036</FONT>    @Stable<a name="line.36"></a>
<FONT color="green">037</FONT>    public interface StartContainerResponse {<a name="line.37"></a>
<FONT color="green">038</FONT>      /**<a name="line.38"></a>
<FONT color="green">039</FONT>       * &lt;p&gt;Get the responses from all auxiliary services running on the <a name="line.39"></a>
<FONT color="green">040</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt;.&lt;/p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>       * &lt;p&gt;The responses are returned as a Map between the auxiliary service names<a name="line.41"></a>
<FONT color="green">042</FONT>       * and their corresponding opaque blob &lt;code&gt;ByteBuffer&lt;/code&gt;s&lt;/p&gt; <a name="line.42"></a>
<FONT color="green">043</FONT>       * @return a Map between the auxiliary service names and their outputs<a name="line.43"></a>
<FONT color="green">044</FONT>       */<a name="line.44"></a>
<FONT color="green">045</FONT>      Map&lt;String, ByteBuffer&gt; getAllServiceResponse();<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>      /**<a name="line.47"></a>
<FONT color="green">048</FONT>       * Get the response from a single auxiliary service running on the<a name="line.48"></a>
<FONT color="green">049</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>       * <a name="line.50"></a>
<FONT color="green">051</FONT>       * @param key The auxiliary service name whose response is desired.<a name="line.51"></a>
<FONT color="green">052</FONT>       * @return The opaque blob &lt;code&gt;ByteBuffer&lt;/code&gt; returned by the auxiliary<a name="line.52"></a>
<FONT color="green">053</FONT>       * service.<a name="line.53"></a>
<FONT color="green">054</FONT>       */<a name="line.54"></a>
<FONT color="green">055</FONT>      ByteBuffer getServiceResponse(String key);<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>      /**<a name="line.57"></a>
<FONT color="green">058</FONT>       * Add to the list of auxiliary services which have been started on the<a name="line.58"></a>
<FONT color="green">059</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt;. This is done only once when the<a name="line.59"></a>
<FONT color="green">060</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt; starts up<a name="line.60"></a>
<FONT color="green">061</FONT>       * @param serviceResponse A map from auxiliary service names to the opaque<a name="line.61"></a>
<FONT color="green">062</FONT>       * blob &lt;code&gt;ByteBuffer&lt;/code&gt;s for that auxiliary service<a name="line.62"></a>
<FONT color="green">063</FONT>       */<a name="line.63"></a>
<FONT color="green">064</FONT>      void addAllServiceResponse(Map&lt;String, ByteBuffer&gt; serviceResponse);<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>      /**<a name="line.66"></a>
<FONT color="green">067</FONT>       * Add to the list of auxiliary services which have been started on the<a name="line.67"></a>
<FONT color="green">068</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt;. This is done only once when the<a name="line.68"></a>
<FONT color="green">069</FONT>       * &lt;code&gt;NodeManager&lt;/code&gt; starts up<a name="line.69"></a>
<FONT color="green">070</FONT>       * <a name="line.70"></a>
<FONT color="green">071</FONT>       * @param key The auxiliary service name<a name="line.71"></a>
<FONT color="green">072</FONT>       * @param value The opaque blob &lt;code&gt;ByteBuffer&lt;/code&gt; managed by the<a name="line.72"></a>
<FONT color="green">073</FONT>       * auxiliary service<a name="line.73"></a>
<FONT color="green">074</FONT>       */<a name="line.74"></a>
<FONT color="green">075</FONT>      void setServiceResponse(String key, ByteBuffer value);<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>      /**<a name="line.77"></a>
<FONT color="green">078</FONT>       * Remove a single auxiliary service from the StartContainerResponse object<a name="line.78"></a>
<FONT color="green">079</FONT>       * @param key The auxiliary service to remove<a name="line.79"></a>
<FONT color="green">080</FONT>       */<a name="line.80"></a>
<FONT color="green">081</FONT>      void removeServiceResponse(String key);<a name="line.81"></a>
<FONT color="green">082</FONT>      <a name="line.82"></a>
<FONT color="green">083</FONT>      /**<a name="line.83"></a>
<FONT color="green">084</FONT>       * Remove all the auxiliary services from the StartContainerResponse object<a name="line.84"></a>
<FONT color="green">085</FONT>       */<a name="line.85"></a>
<FONT color="green">086</FONT>      void clearServiceResponse();<a name="line.86"></a>
<FONT color="green">087</FONT>    }<a name="line.87"></a>




























































</PRE>
</BODY>
</HTML>
