| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:11:22 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ContainerExecutor (Apache Hadoop YARN NodeManager 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ContainerExecutor (Apache Hadoop YARN NodeManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":6,"i18":10,"i19":6,"i20":6,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":6,"i28":6,"i29":10,"i30":10,"i31":6,"i32":10,"i33":6,"i34":10,"i35":6,"i36":6,"i37":10,"i38":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ContainerExecutor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/CMgrUpdateContainersEvent.html" title="class in org.apache.hadoop.yarn.server.nodemanager"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.DelayedProcessKiller.html" title="class in org.apache.hadoop.yarn.server.nodemanager"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html" target="_top">Frames</a></li> |
| <li><a href="ContainerExecutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.nodemanager</div> |
| <h2 title="Class ContainerExecutor" class="title">Class ContainerExecutor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.nodemanager.ContainerExecutor</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.hadoop.conf.Configurable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/DefaultContainerExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager">DefaultContainerExecutor</a>, <a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/LinuxContainerExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager">LinuxContainerExecutor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">ContainerExecutor</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements org.apache.hadoop.conf.Configurable</pre> |
| <div class="block">This class is abstraction of the mechanism used to launch a container on the |
| underlying OS. All executor implementations must extend ContainerExecutor.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.DelayedProcessKiller.html" title="class in org.apache.hadoop.yarn.server.nodemanager">ContainerExecutor.DelayedProcessKiller</a></span></code> |
| <div class="block">This class will signal a target container after a specified delay.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.ExitCode.html" title="enum in org.apache.hadoop.yarn.server.nodemanager">ContainerExecutor.ExitCode</a></span></code> |
| <div class="block">The container exit code.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.Signal.html" title="enum in org.apache.hadoop.yarn.server.nodemanager">ContainerExecutor.Signal</a></span></code> |
| <div class="block">The constants for the signals.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#DIRECTORY_CONTENTS">DIRECTORY_CONTENTS</a></span></code> |
| <div class="block">The relative path to which debug information will be written.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.permission.FsPermission</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#TASK_LAUNCH_SCRIPT_PERMISSION">TASK_LAUNCH_SCRIPT_PERMISSION</a></span></code> |
| <div class="block">The permissions to use when creating the launch script.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#TOKEN_FILE_NAME_FMT">TOKEN_FILE_NAME_FMT</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#WILDCARD">WILDCARD</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#ContainerExecutor--">ContainerExecutor</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#activateContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.fs.Path-">activateContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| org.apache.hadoop.fs.Path pidFilePath)</code> |
| <div class="block">Mark the container as active.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#cleanupBeforeRelaunch-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">cleanupBeforeRelaunch</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> |
| <div class="block">Perform any cleanup before the next launch of the container.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#deactivateContainer-org.apache.hadoop.yarn.api.records.ContainerId-">deactivateContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerId)</code> |
| <div class="block">Mark the container as inactive.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#deleteAsUser-org.apache.hadoop.yarn.server.nodemanager.executor.DeletionAsUserContext-">deleteAsUser</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/DeletionAsUserContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">DeletionAsUserContext</a> ctx)</code> |
| <div class="block">Delete specified directories as a given user.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#execContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerExecContext-">execContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerExecContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerExecContext</a> ctx)</code> |
| <div class="block">Perform interactive docker command into running container.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getConf--">getConf</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getExposedPorts-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getExposedPorts</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getIpAndHost</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getLocalIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getLocalIpAndHost</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.hadoop.yarn.api.records.LocalResource></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getLocalResources-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getLocalResources</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getNMEnvVar-java.lang.String-">getNMEnvVar</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> varname)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getPidFilePath-org.apache.hadoop.yarn.api.records.ContainerId-">getPidFilePath</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerId)</code> |
| <div class="block">Get the pidFile of the container.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getProcessId-org.apache.hadoop.yarn.api.records.ContainerId-">getProcessId</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerID)</code> |
| <div class="block">Get the process-identifier for the container.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getRunCommand-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">getRunCommand</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config)</code> |
| <div class="block">Return a command line to execute the given command in the OS shell.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getRunCommand-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.Resource-">getRunCommand</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Return a command line to execute the given command in the OS shell.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getRunCommandForOther-java.lang.String-org.apache.hadoop.conf.Configuration-">getRunCommandForOther</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| org.apache.hadoop.conf.Configuration config)</code> |
| <div class="block">Return a command line to execute the given command in the OS shell.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#getRunCommandForWindows-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.Resource-">getRunCommandForWindows</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Return a command line to execute the given command in the OS shell.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#init-org.apache.hadoop.yarn.server.nodemanager.Context-">init</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> nmContext)</code> |
| <div class="block">Run the executor initialization steps.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#isContainerActive-org.apache.hadoop.yarn.api.records.ContainerId-">isContainerActive</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerId)</code> |
| <div class="block">Return whether the container is still active.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#isContainerAlive-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerLivenessContext-">isContainerAlive</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerLivenessContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerLivenessContext</a> ctx)</code> |
| <div class="block">Check if a container is alive.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#launchContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerStartContext-">launchContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerStartContext</a> ctx)</code> |
| <div class="block">Launch the container on the node.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#localizeClasspathJar-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.String-">localizeClasspathJar</a></span>(org.apache.hadoop.fs.Path jarPath, |
| org.apache.hadoop.fs.Path target, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> owner)</code> |
| <div class="block">This function localizes the JAR file on-demand.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#logOutput-java.lang.String-">logOutput</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> output)</code> |
| <div class="block">Log each line of the output string as INFO level log messages.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#pauseContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">pauseContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> |
| <div class="block">Pause the container.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#prepareContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerPrepareContext-">prepareContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerPrepareContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerPrepareContext</a> ctx)</code> |
| <div class="block">Prepare the container prior to the launch environment being written.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#reacquireContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerReacquisitionContext-">reacquireContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerReacquisitionContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerReacquisitionContext</a> ctx)</code> |
| <div class="block">Recover an already existing container.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#readDirAsUser-java.lang.String-org.apache.hadoop.fs.Path-">readDirAsUser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| org.apache.hadoop.fs.Path dir)</code> |
| <div class="block">Return the files in the target directory.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#reapContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerReapContext-">reapContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerReapContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerReapContext</a> ctx)</code> |
| <div class="block">Perform the steps necessary to reap the container.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#relaunchContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerStartContext-">relaunchContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerStartContext</a> ctx)</code> |
| <div class="block">Relaunch the container on the node.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#resumeContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">resumeContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> |
| <div class="block">Resume the container from pause state.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#signalContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerSignalContext-">signalContainer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerSignalContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerSignalContext</a> ctx)</code> |
| <div class="block">Signal container with the specified signal.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#start--">start</a></span>()</code> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#startLocalizer-org.apache.hadoop.yarn.server.nodemanager.executor.LocalizerStartContext-">startLocalizer</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/LocalizerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">LocalizerStartContext</a> ctx)</code> |
| <div class="block">Prepare the environment for containers in this application to execute.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#stop--">stop</a></span>()</code> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#symLink-java.lang.String-java.lang.String-">symLink</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> symlink)</code> |
| <div class="block">Create a symlink file which points to the target.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#updateYarnSysFS-org.apache.hadoop.yarn.server.nodemanager.Context-java.lang.String-java.lang.String-java.lang.String-">updateYarnSysFS</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> ctx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> spec)</code> |
| <div class="block">Update cluster information inside container.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#writeLaunchEnv-java.io.OutputStream-java.util.Map-java.util.Map-java.util.List-org.apache.hadoop.fs.Path-java.lang.String-java.util.LinkedHashSet-">writeLaunchEnv</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> environment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.hadoop.fs.Path,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> resources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> command, |
| org.apache.hadoop.fs.Path logDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util">LinkedHashSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nmVars)</code> |
| <div class="block">This method writes out the launch environment of a container to the |
| default container launch script.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html#writeLaunchEnv-java.io.OutputStream-java.util.Map-java.util.Map-java.util.List-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-java.util.LinkedHashSet-">writeLaunchEnv</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> environment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.hadoop.fs.Path,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> resources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> command, |
| org.apache.hadoop.fs.Path logDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> outFilename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util">LinkedHashSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nmVars)</code> |
| <div class="block">This method writes out the launch environment of a container to a specified |
| path.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="WILDCARD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WILDCARD</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WILDCARD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.ContainerExecutor.WILDCARD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TOKEN_FILE_NAME_FMT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TOKEN_FILE_NAME_FMT</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOKEN_FILE_NAME_FMT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.ContainerExecutor.TOKEN_FILE_NAME_FMT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TASK_LAUNCH_SCRIPT_PERMISSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TASK_LAUNCH_SCRIPT_PERMISSION</h4> |
| <pre>public static final org.apache.hadoop.fs.permission.FsPermission TASK_LAUNCH_SCRIPT_PERMISSION</pre> |
| <div class="block">The permissions to use when creating the launch script.</div> |
| </li> |
| </ul> |
| <a name="DIRECTORY_CONTENTS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DIRECTORY_CONTENTS</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DIRECTORY_CONTENTS</pre> |
| <div class="block">The relative path to which debug information will be written.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/launcher/ContainerLaunch.ShellScriptBuilder.html#listDebugInformation-org.apache.hadoop.fs.Path-"><code>ContainerLaunch.ShellScriptBuilder.listDebugInformation(org.apache.hadoop.fs.Path)</code></a>, |
| <a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.ContainerExecutor.DIRECTORY_CONTENTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ContainerExecutor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ContainerExecutor</h4> |
| <pre>public ContainerExecutor()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setConf-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConf</h4> |
| <pre>public void setConf(org.apache.hadoop.conf.Configuration conf)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setConf</code> in interface <code>org.apache.hadoop.conf.Configurable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConf</h4> |
| <pre>public org.apache.hadoop.conf.Configuration getConf()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getConf</code> in interface <code>org.apache.hadoop.conf.Configurable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-org.apache.hadoop.yarn.server.nodemanager.Context-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public abstract void init(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> nmContext) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Run the executor initialization steps. |
| Verify that the necessary configs and permissions are in place.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nmContext</code> - Context of NM</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if initialization fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public void stop()</pre> |
| </li> |
| </ul> |
| <a name="localizeClasspathJar-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localizeClasspathJar</h4> |
| <pre>public org.apache.hadoop.fs.Path localizeClasspathJar(org.apache.hadoop.fs.Path jarPath, |
| org.apache.hadoop.fs.Path target, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> owner) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">This function localizes the JAR file on-demand. |
| On Windows the ContainerLaunch creates a temporary special JAR manifest of |
| other JARs to workaround the CLASSPATH length. In a secure cluster this |
| JAR must be localized so that the container has access to it. |
| The default implementation returns the classpath passed to it, which |
| is expected to have been created in the node manager's <i>fprivate</i> |
| folder, which will not work with secure Windows clusters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jarPath</code> - the path to the JAR to localize</dd> |
| <dd><code>target</code> - the directory where the JAR file should be localized</dd> |
| <dd><code>owner</code> - the name of the user who should own the localized file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the path to the localized JAR file</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if localization fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocalizer-org.apache.hadoop.yarn.server.nodemanager.executor.LocalizerStartContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocalizer</h4> |
| <pre>public abstract void startLocalizer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/LocalizerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">LocalizerStartContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Prepare the environment for containers in this application to execute. |
| <pre> |
| For $x in local.dirs |
| create $x/$user/$appId |
| Copy $nmLocal/appTokens -> $N/$user/$appId |
| For $rsrc in private resources |
| Copy $rsrc -> $N/$user/filecache/[idef] |
| For $rsrc in job resources |
| Copy $rsrc -> $N/$user/$appId/filecache/idef |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - LocalizerStartContext that encapsulates necessary information |
| for starting a localizer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - for most application init failures</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if application init thread is halted by NM</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerPrepareContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareContainer</h4> |
| <pre>public void prepareContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerPrepareContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerPrepareContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Prepare the container prior to the launch environment being written.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for launching containers.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if errors occur during container preparation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="launchContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerStartContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>launchContainer</h4> |
| <pre>public abstract int launchContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerStartContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.ConfigurationException</pre> |
| <div class="block">Launch the container on the node. This is a blocking call and returns only |
| when the container exits.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for launching containers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the return status of the launch</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the container launch fails</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.ConfigurationException</code> - if config error was found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="relaunchContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerStartContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>relaunchContainer</h4> |
| <pre>public abstract int relaunchContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerStartContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerStartContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.ConfigurationException</pre> |
| <div class="block">Relaunch the container on the node. This is a blocking call and returns |
| only when the container exits.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for relaunching containers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the return status of the relaunch</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the container relaunch fails</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.ConfigurationException</code> - if config error was found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="signalContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerSignalContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signalContainer</h4> |
| <pre>public abstract boolean signalContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerSignalContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerSignalContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Signal container with the specified signal.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for signaling containers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns true if the operation succeeded</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if signaling the container fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reapContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerReapContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reapContainer</h4> |
| <pre>public abstract boolean reapContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerReapContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerReapContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Perform the steps necessary to reap the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for reaping containers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns true if the operation succeeded.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if reaping the container fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerExecContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execContainer</h4> |
| <pre>public abstract org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair execContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerExecContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerExecContext</a> ctx) |
| throws <a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block">Perform interactive docker command into running container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for exec containers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>return input/output stream if the operation succeeded.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if container exec fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAsUser-org.apache.hadoop.yarn.server.nodemanager.executor.DeletionAsUserContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAsUser</h4> |
| <pre>public abstract void deleteAsUser(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/DeletionAsUserContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">DeletionAsUserContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Delete specified directories as a given user.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for deletion.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if delete fails</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted while waiting for the deletion |
| operation to complete</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="symLink-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>symLink</h4> |
| <pre>public abstract void symLink(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> symlink) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Create a symlink file which points to the target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The target for symlink</dd> |
| <dd><code>symlink</code> - the symlink file</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Error when creating symlinks</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isContainerAlive-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerLivenessContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isContainerAlive</h4> |
| <pre>public abstract boolean isContainerAlive(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerLivenessContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerLivenessContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Check if a container is alive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Encapsulates information necessary for container liveness check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if container is still alive</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a failure while checking the container |
| status</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalResources-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalResources</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.hadoop.yarn.api.records.LocalResource> getLocalResources(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateYarnSysFS-org.apache.hadoop.yarn.server.nodemanager.Context-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateYarnSysFS</h4> |
| <pre>public abstract void updateYarnSysFS(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> ctx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> spec) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Update cluster information inside container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - ContainerRuntimeContext</dd> |
| <dd><code>user</code> - Owner of application</dd> |
| <dd><code>appId</code> - YARN application ID</dd> |
| <dd><code>spec</code> - Service Specification</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a failure while writing spec to disk</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reacquireContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerReacquisitionContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reacquireContainer</h4> |
| <pre>public int reacquireContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerReacquisitionContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerReacquisitionContext</a> ctx) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Recover an already existing container. This is a blocking call and returns |
| only when the container exits. Note that the container must have been |
| activated prior to this call.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - encapsulates information necessary to reacquire container</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The exit code of the pre-existing container</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a failure while reacquiring the container</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted while waiting to reacquire |
| the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeLaunchEnv-java.io.OutputStream-java.util.Map-java.util.Map-java.util.List-org.apache.hadoop.fs.Path-java.lang.String-java.util.LinkedHashSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLaunchEnv</h4> |
| <pre>public void writeLaunchEnv(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> environment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.hadoop.fs.Path,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> resources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> command, |
| org.apache.hadoop.fs.Path logDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util">LinkedHashSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nmVars) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">This method writes out the launch environment of a container to the |
| default container launch script. For the default container script path see |
| <a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/launcher/ContainerLaunch.html#CONTAINER_SCRIPT"><code>ContainerLaunch.CONTAINER_SCRIPT</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - the output stream to which the environment is written (usually |
| a script file which will be executed by the Launcher)</dd> |
| <dd><code>environment</code> - the environment variables and their values</dd> |
| <dd><code>resources</code> - the resources which have been localized for this |
| container. Symlinks will be created to these localized resources</dd> |
| <dd><code>command</code> - the command that will be run</dd> |
| <dd><code>logDir</code> - the log dir to which to copy debugging information</dd> |
| <dd><code>user</code> - the username of the job owner</dd> |
| <dd><code>nmVars</code> - the set of environment vars that are explicitly set by NM</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if any errors happened writing to the OutputStream, |
| while creating symlinks</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeLaunchEnv-java.io.OutputStream-java.util.Map-java.util.Map-java.util.List-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-java.util.LinkedHashSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLaunchEnv</h4> |
| <pre>public void writeLaunchEnv(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> environment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.hadoop.fs.Path,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> resources, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> command, |
| org.apache.hadoop.fs.Path logDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> outFilename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util">LinkedHashSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nmVars) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">This method writes out the launch environment of a container to a specified |
| path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - the output stream to which the environment is written (usually |
| a script file which will be executed by the Launcher)</dd> |
| <dd><code>environment</code> - the environment variables and their values</dd> |
| <dd><code>resources</code> - the resources which have been localized for this |
| container. Symlinks will be created to these localized resources</dd> |
| <dd><code>command</code> - the command that will be run</dd> |
| <dd><code>logDir</code> - the log dir to which to copy debugging information</dd> |
| <dd><code>user</code> - the username of the job owner</dd> |
| <dd><code>outFilename</code> - the path to which to write the launch environment</dd> |
| <dd><code>nmVars</code> - the set of environment vars that are explicitly set by NM</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if any errors happened writing to the OutputStream, |
| while creating symlinks</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readDirAsUser-java.lang.String-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readDirAsUser</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] readDirAsUser(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| org.apache.hadoop.fs.Path dir)</pre> |
| <div class="block">Return the files in the target directory. If retrieving the list of files |
| requires specific access rights, that access will happen as the |
| specified user. The list will not include entries for "." or "..".</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>user</code> - the user as whom to access the target directory</dd> |
| <dd><code>dir</code> - the target directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of files in the target directory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logOutput-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logOutput</h4> |
| <pre>protected void logOutput(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> output)</pre> |
| <div class="block">Log each line of the output string as INFO level log messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>output</code> - the output string to log</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPidFilePath-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPidFilePath</h4> |
| <pre>protected org.apache.hadoop.fs.Path getPidFilePath(org.apache.hadoop.yarn.api.records.ContainerId containerId)</pre> |
| <div class="block">Get the pidFile of the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerId</code> - the container ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the path of the pid-file for the given containerId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRunCommand-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRunCommand</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getRunCommand(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config)</pre> |
| <div class="block">Return a command line to execute the given command in the OS shell. |
| On Windows, the {code}groupId{code} parameter can be used to launch |
| and associate the given GID with a process group. On |
| non-Windows hosts, the {code}groupId{code} parameter is ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the command to execute</dd> |
| <dd><code>groupId</code> - the job owner's GID</dd> |
| <dd><code>userName</code> - the job owner's username</dd> |
| <dd><code>pidFile</code> - the path to the container's PID file</dd> |
| <dd><code>config</code> - the configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the command line to execute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRunCommand-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRunCommand</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getRunCommand(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Return a command line to execute the given command in the OS shell. |
| On Windows, the {code}groupId{code} parameter can be used to launch |
| and associate the given GID with a process group. On |
| non-Windows hosts, the {code}groupId{code} parameter is ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the command to execute</dd> |
| <dd><code>groupId</code> - the job owner's GID for Windows. On other operating systems |
| it is ignored.</dd> |
| <dd><code>userName</code> - the job owner's username for Windows. On other operating |
| systems it is ignored.</dd> |
| <dd><code>pidFile</code> - the path to the container's PID file on Windows. On other |
| operating systems it is ignored.</dd> |
| <dd><code>config</code> - the configuration</dd> |
| <dd><code>resource</code> - on Windows this parameter controls memory and CPU limits. |
| If null, no limits are set. On other operating systems it is ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the command line to execute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRunCommandForWindows-java.lang.String-java.lang.String-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRunCommandForWindows</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getRunCommandForWindows(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| org.apache.hadoop.fs.Path pidFile, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Return a command line to execute the given command in the OS shell. |
| The {code}groupId{code} parameter can be used to launch |
| and associate the given GID with a process group.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the command to execute</dd> |
| <dd><code>groupId</code> - the job owner's GID</dd> |
| <dd><code>userName</code> - the job owner's username</dd> |
| <dd><code>pidFile</code> - the path to the container's PID file</dd> |
| <dd><code>config</code> - the configuration</dd> |
| <dd><code>resource</code> - this parameter controls memory and CPU limits. |
| If null, no limits are set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the command line to execute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRunCommandForOther-java.lang.String-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRunCommandForOther</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getRunCommandForOther(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command, |
| org.apache.hadoop.conf.Configuration config)</pre> |
| <div class="block">Return a command line to execute the given command in the OS shell.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the command to execute</dd> |
| <dd><code>config</code> - the configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the command line to execute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isContainerActive-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isContainerActive</h4> |
| <pre>protected boolean isContainerActive(org.apache.hadoop.yarn.api.records.ContainerId containerId)</pre> |
| <div class="block">Return whether the container is still active.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerId</code> - the target container's ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the container is active</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNMEnvVar-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNMEnvVar</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNMEnvVar(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> varname)</pre> |
| </li> |
| </ul> |
| <a name="activateContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>activateContainer</h4> |
| <pre>public void activateContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| org.apache.hadoop.fs.Path pidFilePath)</pre> |
| <div class="block">Mark the container as active.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerId</code> - the container ID</dd> |
| <dd><code>pidFilePath</code> - the path where the executor should write the PID |
| of the launched process</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIpAndHost</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getIpAndHost(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container) |
| throws <a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalIpAndHost</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getLocalIpAndHost(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</pre> |
| </li> |
| </ul> |
| <a name="deactivateContainer-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deactivateContainer</h4> |
| <pre>public void deactivateContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)</pre> |
| <div class="block">Mark the container as inactive. For inactive containers this |
| method has no effect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerId</code> - the container ID</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pauseContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pauseContainer</h4> |
| <pre>public void pauseContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</pre> |
| <div class="block">Pause the container. The default implementation is to raise a kill event. |
| Specific executor implementations can override this behavior.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>container</code> - the Container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resumeContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resumeContainer</h4> |
| <pre>public void resumeContainer(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</pre> |
| <div class="block">Resume the container from pause state. The default implementation ignores |
| this event. Specific implementations can override this behavior.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>container</code> - the Container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cleanupBeforeRelaunch-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanupBeforeRelaunch</h4> |
| <pre>public void cleanupBeforeRelaunch(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Perform any cleanup before the next launch of the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>container</code> - container</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProcessId-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcessId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProcessId(org.apache.hadoop.yarn.api.records.ContainerId containerID)</pre> |
| <div class="block">Get the process-identifier for the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerID</code> - the container ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the process ID of the container if it has already launched, |
| or null otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExposedPorts-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getExposedPorts</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getExposedPorts(<a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container) |
| throws <a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ContainerExecutor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/CMgrUpdateContainersEvent.html" title="class in org.apache.hadoop.yarn.server.nodemanager"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.DelayedProcessKiller.html" title="class in org.apache.hadoop.yarn.server.nodemanager"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.html" target="_top">Frames</a></li> |
| <li><a href="ContainerExecutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |