<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.records;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.hadoop.classification.InterfaceAudience.Private;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.hadoop.classification.InterfaceAudience.Public;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.hadoop.classification.InterfaceStability.Stable;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.hadoop.classification.InterfaceStability.Unstable;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.hadoop.yarn.api.ClientRMProtocol;<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;&lt;code&gt;ApplicationSubmissionContext&lt;/code&gt; represents all of the<a name="line.29"></a>
<FONT color="green">030</FONT>     * information needed by the &lt;code&gt;ResourceManager&lt;/code&gt; to launch <a name="line.30"></a>
<FONT color="green">031</FONT>     * the &lt;code&gt;ApplicationMaster&lt;/code&gt; for an application.&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * <a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;p&gt;It includes details such as:<a name="line.33"></a>
<FONT color="green">034</FONT>     *   &lt;ul&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     *     &lt;li&gt;{@link ApplicationId} of the application.&lt;/li&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     *     &lt;li&gt;Application user.&lt;/li&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     *     &lt;li&gt;Application name.&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     *     &lt;li&gt;{@link Priority} of the application.&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     *     &lt;li&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     *       {@link ContainerLaunchContext} of the container in which the <a name="line.40"></a>
<FONT color="green">041</FONT>     *       &lt;code&gt;ApplicationMaster&lt;/code&gt; is executed.<a name="line.41"></a>
<FONT color="green">042</FONT>     *     &lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     *   &lt;/ul&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * &lt;/p&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     * <a name="line.45"></a>
<FONT color="green">046</FONT>     * @see ContainerLaunchContext<a name="line.46"></a>
<FONT color="green">047</FONT>     * @see ClientRMProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)<a name="line.47"></a>
<FONT color="green">048</FONT>     */<a name="line.48"></a>
<FONT color="green">049</FONT>    @Public<a name="line.49"></a>
<FONT color="green">050</FONT>    @Stable<a name="line.50"></a>
<FONT color="green">051</FONT>    public interface ApplicationSubmissionContext {<a name="line.51"></a>
<FONT color="green">052</FONT>      /**<a name="line.52"></a>
<FONT color="green">053</FONT>       * Get the &lt;code&gt;ApplicationId&lt;/code&gt; of the submitted application.<a name="line.53"></a>
<FONT color="green">054</FONT>       * @return &lt;code&gt;ApplicationId&lt;/code&gt; of the submitted application<a name="line.54"></a>
<FONT color="green">055</FONT>       */<a name="line.55"></a>
<FONT color="green">056</FONT>      @Public<a name="line.56"></a>
<FONT color="green">057</FONT>      @Stable<a name="line.57"></a>
<FONT color="green">058</FONT>      public ApplicationId getApplicationId();<a name="line.58"></a>
<FONT color="green">059</FONT>      <a name="line.59"></a>
<FONT color="green">060</FONT>      /**<a name="line.60"></a>
<FONT color="green">061</FONT>       * Set the &lt;code&gt;ApplicationId&lt;/code&gt; of the submitted application.<a name="line.61"></a>
<FONT color="green">062</FONT>       * @param appplicationId &lt;code&gt;ApplicationId&lt;/code&gt; of the submitted <a name="line.62"></a>
<FONT color="green">063</FONT>       *                       application<a name="line.63"></a>
<FONT color="green">064</FONT>       */<a name="line.64"></a>
<FONT color="green">065</FONT>      @Public<a name="line.65"></a>
<FONT color="green">066</FONT>      @Stable<a name="line.66"></a>
<FONT color="green">067</FONT>      public void setApplicationId(ApplicationId appplicationId);<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>      /**<a name="line.69"></a>
<FONT color="green">070</FONT>       * Get the application &lt;em&gt;name&lt;/em&gt;.<a name="line.70"></a>
<FONT color="green">071</FONT>       * @return application name<a name="line.71"></a>
<FONT color="green">072</FONT>       */<a name="line.72"></a>
<FONT color="green">073</FONT>      @Public<a name="line.73"></a>
<FONT color="green">074</FONT>      @Stable<a name="line.74"></a>
<FONT color="green">075</FONT>      public String getApplicationName();<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>       * Set the application &lt;em&gt;name&lt;/em&gt;.<a name="line.78"></a>
<FONT color="green">079</FONT>       * @param applicationName application name<a name="line.79"></a>
<FONT color="green">080</FONT>       */<a name="line.80"></a>
<FONT color="green">081</FONT>      @Public<a name="line.81"></a>
<FONT color="green">082</FONT>      @Stable<a name="line.82"></a>
<FONT color="green">083</FONT>      public void setApplicationName(String applicationName);<a name="line.83"></a>
<FONT color="green">084</FONT>      <a name="line.84"></a>
<FONT color="green">085</FONT>      /**<a name="line.85"></a>
<FONT color="green">086</FONT>       * Get the &lt;em&gt;queue&lt;/em&gt; to which the application is being submitted.<a name="line.86"></a>
<FONT color="green">087</FONT>       * @return &lt;em&gt;queue&lt;/em&gt; to which the application is being submitted<a name="line.87"></a>
<FONT color="green">088</FONT>       */<a name="line.88"></a>
<FONT color="green">089</FONT>      @Public<a name="line.89"></a>
<FONT color="green">090</FONT>      @Stable<a name="line.90"></a>
<FONT color="green">091</FONT>      public String getQueue();<a name="line.91"></a>
<FONT color="green">092</FONT>      <a name="line.92"></a>
<FONT color="green">093</FONT>      /**<a name="line.93"></a>
<FONT color="green">094</FONT>       * Set the &lt;em&gt;queue&lt;/em&gt; to which the application is being submitted<a name="line.94"></a>
<FONT color="green">095</FONT>       * @param queue &lt;em&gt;queue&lt;/em&gt; to which the application is being submitted<a name="line.95"></a>
<FONT color="green">096</FONT>       */<a name="line.96"></a>
<FONT color="green">097</FONT>      @Public<a name="line.97"></a>
<FONT color="green">098</FONT>      @Stable<a name="line.98"></a>
<FONT color="green">099</FONT>      public void setQueue(String queue);<a name="line.99"></a>
<FONT color="green">100</FONT>      <a name="line.100"></a>
<FONT color="green">101</FONT>      /**<a name="line.101"></a>
<FONT color="green">102</FONT>       * Get the &lt;code&gt;Priority&lt;/code&gt; of the application.<a name="line.102"></a>
<FONT color="green">103</FONT>       * @return &lt;code&gt;Priority&lt;/code&gt; of the application<a name="line.103"></a>
<FONT color="green">104</FONT>       */<a name="line.104"></a>
<FONT color="green">105</FONT>      @Public<a name="line.105"></a>
<FONT color="green">106</FONT>      @Stable<a name="line.106"></a>
<FONT color="green">107</FONT>      public Priority getPriority();<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>      /**<a name="line.109"></a>
<FONT color="green">110</FONT>       * Set the &lt;code&gt;Priority&lt;/code&gt; of the application.<a name="line.110"></a>
<FONT color="green">111</FONT>       * @param priority &lt;code&gt;Priority&lt;/code&gt; of the application<a name="line.111"></a>
<FONT color="green">112</FONT>       */<a name="line.112"></a>
<FONT color="green">113</FONT>      @Public<a name="line.113"></a>
<FONT color="green">114</FONT>      @Stable<a name="line.114"></a>
<FONT color="green">115</FONT>      public void setPriority(Priority priority);<a name="line.115"></a>
<FONT color="green">116</FONT>      <a name="line.116"></a>
<FONT color="green">117</FONT>      /**<a name="line.117"></a>
<FONT color="green">118</FONT>       * Get the &lt;em&gt;user&lt;/em&gt; submitting the application.<a name="line.118"></a>
<FONT color="green">119</FONT>       * @return &lt;em&gt;user&lt;/em&gt; submitting the application<a name="line.119"></a>
<FONT color="green">120</FONT>       */<a name="line.120"></a>
<FONT color="green">121</FONT>      @Public<a name="line.121"></a>
<FONT color="green">122</FONT>      @Stable<a name="line.122"></a>
<FONT color="green">123</FONT>      public String getUser();<a name="line.123"></a>
<FONT color="green">124</FONT>      <a name="line.124"></a>
<FONT color="green">125</FONT>      /**<a name="line.125"></a>
<FONT color="green">126</FONT>       * Set the &lt;em&gt;user&lt;/em&gt; submitting the application.<a name="line.126"></a>
<FONT color="green">127</FONT>       * @param user &lt;em&gt;user&lt;/em&gt; submitting the application<a name="line.127"></a>
<FONT color="green">128</FONT>       */<a name="line.128"></a>
<FONT color="green">129</FONT>      @Public<a name="line.129"></a>
<FONT color="green">130</FONT>      @Stable<a name="line.130"></a>
<FONT color="green">131</FONT>      public void setUser(String user);<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>      /**<a name="line.133"></a>
<FONT color="green">134</FONT>       * Get the &lt;code&gt;ContainerLaunchContext&lt;/code&gt; to describe the <a name="line.134"></a>
<FONT color="green">135</FONT>       * &lt;code&gt;Container&lt;/code&gt; with which the &lt;code&gt;ApplicationMaster&lt;/code&gt; is<a name="line.135"></a>
<FONT color="green">136</FONT>       * launched.<a name="line.136"></a>
<FONT color="green">137</FONT>       * @return &lt;code&gt;ContainerLaunchContext&lt;/code&gt; for the <a name="line.137"></a>
<FONT color="green">138</FONT>       *         &lt;code&gt;ApplicationMaster&lt;/code&gt; container<a name="line.138"></a>
<FONT color="green">139</FONT>       */<a name="line.139"></a>
<FONT color="green">140</FONT>      @Public<a name="line.140"></a>
<FONT color="green">141</FONT>      @Stable<a name="line.141"></a>
<FONT color="green">142</FONT>      public ContainerLaunchContext getAMContainerSpec();<a name="line.142"></a>
<FONT color="green">143</FONT>      <a name="line.143"></a>
<FONT color="green">144</FONT>      /**<a name="line.144"></a>
<FONT color="green">145</FONT>       * Set the &lt;code&gt;ContainerLaunchContext&lt;/code&gt; to describe the <a name="line.145"></a>
<FONT color="green">146</FONT>       * &lt;code&gt;Container&lt;/code&gt; with which the &lt;code&gt;ApplicationMaster&lt;/code&gt; is<a name="line.146"></a>
<FONT color="green">147</FONT>       * launched.<a name="line.147"></a>
<FONT color="green">148</FONT>       * @param amContainer &lt;code&gt;ContainerLaunchContext&lt;/code&gt; for the <a name="line.148"></a>
<FONT color="green">149</FONT>       *                    &lt;code&gt;ApplicationMaster&lt;/code&gt; container<a name="line.149"></a>
<FONT color="green">150</FONT>       */<a name="line.150"></a>
<FONT color="green">151</FONT>      @Public<a name="line.151"></a>
<FONT color="green">152</FONT>      @Stable<a name="line.152"></a>
<FONT color="green">153</FONT>      public void setAMContainerSpec(ContainerLaunchContext amContainer);<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>      /**<a name="line.155"></a>
<FONT color="green">156</FONT>       * @return true if tokens should be canceled when the app completes.<a name="line.156"></a>
<FONT color="green">157</FONT>       */<a name="line.157"></a>
<FONT color="green">158</FONT>      @LimitedPrivate("mapreduce")<a name="line.158"></a>
<FONT color="green">159</FONT>      @Unstable<a name="line.159"></a>
<FONT color="green">160</FONT>      public boolean getCancelTokensWhenComplete();<a name="line.160"></a>
<FONT color="green">161</FONT>      <a name="line.161"></a>
<FONT color="green">162</FONT>      /**<a name="line.162"></a>
<FONT color="green">163</FONT>       * Set to false if tokens should not be canceled when the app finished else<a name="line.163"></a>
<FONT color="green">164</FONT>       * false.  WARNING: this is not recommended unless you want your single job<a name="line.164"></a>
<FONT color="green">165</FONT>       * tokens to be reused by others jobs.<a name="line.165"></a>
<FONT color="green">166</FONT>       * @param cancel true if tokens should be canceled when the app finishes. <a name="line.166"></a>
<FONT color="green">167</FONT>       */<a name="line.167"></a>
<FONT color="green">168</FONT>      @LimitedPrivate("mapreduce")<a name="line.168"></a>
<FONT color="green">169</FONT>      @Unstable<a name="line.169"></a>
<FONT color="green">170</FONT>      public void setCancelTokensWhenComplete(boolean cancel);<a name="line.170"></a>
<FONT color="green">171</FONT>    }<a name="line.171"></a>




























































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