content/docs/r3.3.1/api/org/apache/hadoop/util/Shell.html - hadoop-site - Git at Google

 <!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:00:45 GMT 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Shell (Apache Hadoop Main 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="Shell (Apache Hadoop Main 3.3.1 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":10,"i11":9,"i12":6,"i13":10,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":10,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":10,"i32":9,"i33":9,"i34":9,"i35":41,"i36":9,"i37":10,"i38":6,"i39":10,"i40":10,"i41":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Shell.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/util/ReflectionUtils.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/hadoop/util/ShutdownHookManager.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/hadoop/util/Shell.html" target="_top">Frames</a></li>
 <li><a href="Shell.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.util</div>
 <h2 title="Class Shell" class="title">Class Shell</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.util.Shell</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@InterfaceAudience.Public
  @InterfaceStability.Evolving
 public abstract class <span class="typeNameLabel">Shell</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></pre>
 <div class="block">A base class for running a Shell command.

  <code>Shell</code> can be used to run shell commands like <code>du</code> or
  <code>df</code>. It also offers facilities to gate commands by
  time-intervals.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== 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">&nbsp;</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/util/Shell.html#ENV_HADOOP_HOME">ENV_HADOOP_HOME</a></span></code>
 <div class="block">Environment variable for Hadoop's home dir: "HADOOP_HOME".</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#ENV_NAME_REGEX">ENV_NAME_REGEX</a></span></code>
 <div class="block">Regular expression for environment variables: "[A-Za-z_][A-Za-z0-9_]*".</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#FREEBSD">FREEBSD</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#inheritParentEnv">inheritParentEnv</a></span></code>
 <div class="block">Indicates if the parent env vars should be inherited or not</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#isSetsidAvailable">isSetsidAvailable</a></span></code>
 <div class="block">Flag which is true if setsid exists.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#LINK_COMMAND">LINK_COMMAND</a></span></code>
 <div class="block">a Unix command to create a link: "ln".</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#LINUX">LINUX</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static org.slf4j.Logger</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#LOG">LOG</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#MAC">MAC</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static org.apache.hadoop.util.Shell.OSType</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#osType">osType</a></span></code>
 <div class="block">Get the type of the operating system, as determined from parsing
  the <code>os.name</code> property.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#OTHER">OTHER</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#PPC_64">PPC_64</a></span></code>&nbsp;</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/util/Shell.html#READ_LINK_COMMAND">READ_LINK_COMMAND</a></span></code>
 <div class="block">a Unix command to get a link target: "readlink".</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#SET_GROUP_COMMAND">SET_GROUP_COMMAND</a></span></code>
 <div class="block">a Unix command to set the change user's groups list: "chgrp".</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/util/Shell.html#SET_OWNER_COMMAND">SET_OWNER_COMMAND</a></span></code>
 <div class="block">a Unix command to set owner: "chown".</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#SET_PERMISSION_COMMAND">SET_PERMISSION_COMMAND</a></span></code>
 <div class="block">a Unix command to set permission: "chmod".</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#SOLARIS">SOLARIS</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#SYSPROP_HADOOP_HOME_DIR">SYSPROP_HADOOP_HOME_DIR</a></span></code>
 <div class="block">System property for the Hadoop home directory: "hadoop.home.dir".</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#timeOutInterval">timeOutInterval</a></span></code>
 <div class="block">Time after which the executing script would be timedout.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#TOKEN_SEPARATOR_REGEX">TOKEN_SEPARATOR_REGEX</a></span></code>
 <div class="block">Token separator regex used to parse Shell tool outputs.</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/util/Shell.html#USER_NAME_COMMAND">USER_NAME_COMMAND</a></span></code>
 <div class="block">a Unix command to get the current user's name: "whoami".</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS">WINDOWS</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS_MAX_SHELL_LENGHT">WINDOWS_MAX_SHELL_LENGHT</a></span></code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
 <div class="block"><span class="deprecationComment">use the correctly spelled constant.</span></div>
 </div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS_MAX_SHELL_LENGTH">WINDOWS_MAX_SHELL_LENGTH</a></span></code>
 <div class="block">Maximum command line length in Windows
  KB830473 documents this as 8191</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <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></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#WindowsProcessLaunchLock">WindowsProcessLaunchLock</a></span></code>
 <div class="block">Windows <code>CreateProcess</code> synchronization object.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <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/util/Shell.html#WINUTILS">WINUTILS</a></span></code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
 <div class="block"><span class="deprecationComment">use one of the exception-raising getter methods,
  specifically <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsPath--"><code>getWinUtilsPath()</code></a> or <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsFile--"><code>getWinUtilsFile()</code></a></span></div>
 </div>
 </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">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier</th>
 <th class="colLast" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#Shell--">Shell</a></span>()</code>
 <div class="block">Create an instance with no minimum interval between runs; stderr is
  not merged with stdout.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected </code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#Shell-long-">Shell</a></span>(long&nbsp;interval)</code>
 <div class="block">Create an instance with a minimum interval between executions; stderr is
  not merged with stdout.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#Shell-long-boolean-">Shell</a></span>(long&nbsp;interval,
      boolean&nbsp;redirectErrorStream)</code>
 <div class="block">Create a shell instance which can be re-executed when the <a href="../../../../org/apache/hadoop/util/Shell.html#run--"><code>run()</code></a>
  method is invoked with a given elapsed time between calls.</div>
 </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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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>static <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/util/Shell.html#appendScriptExtension-java.io.File-java.lang.String-">appendScriptExtension</a></span>(<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>&nbsp;parent,
                      <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>&nbsp;basename)</code>
 <div class="block">Returns a File referencing a script with the given basename, inside the
  given parent directory.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <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/util/Shell.html#appendScriptExtension-java.lang.String-">appendScriptExtension</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>&nbsp;basename)</code>
 <div class="block">Returns a script file name with the given basename.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#checkIsBashSupported--">checkIsBashSupported</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#checkWindowsCommandLineLength-java.lang.String...-">checkWindowsCommandLineLength</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>...&nbsp;commands)</code>
 <div class="block">Checks if a given command (String[]) fits in the Windows maximum command
  line length Note that the input is expected to already include space
  delimiters, no extra count will be added for delimiters.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#destroyAllShellProcesses--">destroyAllShellProcesses</a></span>()</code>
 <div class="block">Static method to destroy all running <code>Shell</code> processes.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <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/util/Shell.html#execCommand-java.util.Map-java.lang.String...-">execCommand</a></span>(<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>&lt;<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>&gt;&nbsp;env,
            <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>...&nbsp;cmd)</code>
 <div class="block">Static method to execute a shell command.</div>
 </td>
 </tr>
 <tr id="i6" 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/util/Shell.html#execCommand-java.util.Map-java.lang.String:A-long-">execCommand</a></span>(<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>&lt;<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>&gt;&nbsp;env,
            <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>[]&nbsp;cmd,
            long&nbsp;timeout)</code>
 <div class="block">Static method to execute a shell command.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <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/util/Shell.html#execCommand-java.lang.String...-">execCommand</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>...&nbsp;cmd)</code>
 <div class="block">Static method to execute a shell command.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#getAllShells--">getAllShells</a></span>()</code>
 <div class="block">Static method to return a Set of all <code>Shell</code> objects.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <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/util/Shell.html#getCheckProcessIsAliveCommand-java.lang.String-">getCheckProcessIsAliveCommand</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>&nbsp;pid)</code>
 <div class="block">Return a command for determining if process with specified pid is alive.</div>
 </td>
 </tr>
 <tr id="i10" 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/util/Shell.html#getEnvironment-java.lang.String-">getEnvironment</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>&nbsp;env)</code>
 <div class="block">Get an environment variable.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <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/util/Shell.html#getEnvironmentVariableRegex--">getEnvironmentVariableRegex</a></span>()</code>
 <div class="block">Return a regular expression string that match environment variables.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>protected abstract <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/util/Shell.html#getExecString--">getExecString</a></span>()</code>
 <div class="block">return an array containing the command name and its parameters.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#getExitCode--">getExitCode</a></span>()</code>
 <div class="block">get the exit code.</div>
 </td>
 </tr>
 <tr id="i14" 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/util/Shell.html#getGetPermissionCommand--">getGetPermissionCommand</a></span>()</code>
 <div class="block">Return a command to get permission information.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <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/util/Shell.html#getGroupsCommand--">getGroupsCommand</a></span>()</code>
 <div class="block">a Unix command to get the current user's groups list.</div>
 </td>
 </tr>
 <tr id="i16" 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/util/Shell.html#getGroupsForUserCommand-java.lang.String-">getGroupsForUserCommand</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>&nbsp;user)</code>
 <div class="block">A command to get a given user's groups list.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <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/util/Shell.html#getGroupsIDForUserCommand-java.lang.String-">getGroupsIDForUserCommand</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>&nbsp;user)</code>
 <div class="block">A command to get a given user's group id list.</div>
 </td>
 </tr>
 <tr id="i18" 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/util/Shell.html#getHadoopHome--">getHadoopHome</a></span>()</code>
 <div class="block">Get the Hadoop home directory.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#getMemlockLimit-java.lang.Long-">getMemlockLimit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;ulimit)</code>
 <div class="block">Static method to return the memory lock limit for datanode.</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Process.html?is-external=true" title="class or interface in java.lang">Process</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#getProcess--">getProcess</a></span>()</code>
 <div class="block">get the current sub-process executing the given command.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code>static <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/util/Shell.html#getQualifiedBin-java.lang.String-">getQualifiedBin</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>&nbsp;executable)</code>
 <div class="block">Fully qualify the path to a binary that should be in a known hadoop
   bin location.</div>
 </td>
 </tr>
 <tr id="i22" 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/util/Shell.html#getQualifiedBinPath-java.lang.String-">getQualifiedBinPath</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>&nbsp;executable)</code>
 <div class="block">Fully qualify the path to a binary that should be in a known hadoop
   bin location.</div>
 </td>
 </tr>
 <tr id="i23" class="rowColor">
 <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/util/Shell.html#getReadlinkCommand-java.lang.String-">getReadlinkCommand</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>&nbsp;link)</code>
 <div class="block">Return a command to read the target of the a symbolic link.</div>
 </td>
 </tr>
 <tr id="i24" 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/util/Shell.html#getRunScriptCommand-java.io.File-">getRunScriptCommand</a></span>(<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>&nbsp;script)</code>
 <div class="block">Returns a command to run the given script.</div>
 </td>
 </tr>
 <tr id="i25" class="rowColor">
 <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/util/Shell.html#getSetOwnerCommand-java.lang.String-">getSetOwnerCommand</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>&nbsp;owner)</code>
 <div class="block">Return a command to set owner.</div>
 </td>
 </tr>
 <tr id="i26" 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/util/Shell.html#getSetPermissionCommand-java.lang.String-boolean-">getSetPermissionCommand</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>&nbsp;perm,
                        boolean&nbsp;recursive)</code>
 <div class="block">Return a command to set permission.</div>
 </td>
 </tr>
 <tr id="i27" class="rowColor">
 <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/util/Shell.html#getSetPermissionCommand-java.lang.String-boolean-java.lang.String-">getSetPermissionCommand</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>&nbsp;perm,
                        boolean&nbsp;recursive,
                        <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>&nbsp;file)</code>
 <div class="block">Return a command to set permission for specific file.</div>
 </td>
 </tr>
 <tr id="i28" 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/util/Shell.html#getSignalKillCommand-int-java.lang.String-">getSignalKillCommand</a></span>(int&nbsp;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>&nbsp;pid)</code>
 <div class="block">Return a command to send a signal to a given pid.</div>
 </td>
 </tr>
 <tr id="i29" class="rowColor">
 <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/util/Shell.html#getSymlinkCommand-java.lang.String-java.lang.String-">getSymlinkCommand</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>&nbsp;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>&nbsp;link)</code>
 <div class="block">Return a command to create symbolic links.</div>
 </td>
 </tr>
 <tr id="i30" 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/util/Shell.html#getUsersForNetgroupCommand-java.lang.String-">getUsersForNetgroupCommand</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>&nbsp;netgroup)</code>
 <div class="block">A command to get a given netgroup's user list.</div>
 </td>
 </tr>
 <tr id="i31" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#getWaitingThread--">getWaitingThread</a></span>()</code>
 <div class="block">get the thread that is waiting on this instance of <code>Shell</code>.</div>
 </td>
 </tr>
 <tr id="i32" class="altColor">
 <td class="colFirst"><code>static <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/util/Shell.html#getWinUtilsFile--">getWinUtilsFile</a></span>()</code>
 <div class="block">Get a file reference to winutils.</div>
 </td>
 </tr>
 <tr id="i33" class="rowColor">
 <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/util/Shell.html#getWinUtilsPath--">getWinUtilsPath</a></span>()</code>
 <div class="block">Locate the winutils binary, or fail with a meaningful
  exception and stack trace as an RTE.</div>
 </td>
 </tr>
 <tr id="i34" class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#hasWinutilsPath--">hasWinutilsPath</a></span>()</code>
 <div class="block">Predicate to indicate whether or not the path to winutils is known.</div>
 </td>
 </tr>
 <tr id="i35" class="rowColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#isJava7OrAbove--">isJava7OrAbove</a></span>()</code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
 <div class="block"><span class="deprecationComment">This call isn't needed any more: please remove uses of it.</span></div>
 </div>
 </td>
 </tr>
 <tr id="i36" class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#isJavaVersionAtLeast-int-">isJavaVersionAtLeast</a></span>(int&nbsp;version)</code>
 <div class="block">Query to see if major version of Java specification of the system
  is equal or greater than the parameter.</div>
 </td>
 </tr>
 <tr id="i37" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#isTimedOut--">isTimedOut</a></span>()</code>
 <div class="block">To check if the passed script to shell command executor timed out or
  not.</div>
 </td>
 </tr>
 <tr id="i38" class="altColor">
 <td class="colFirst"><code>protected abstract void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#parseExecResult-java.io.BufferedReader-">parseExecResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html?is-external=true" title="class or interface in java.io">BufferedReader</a>&nbsp;lines)</code>
 <div class="block">Parse the execution result</div>
 </td>
 </tr>
 <tr id="i39" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#run--">run</a></span>()</code>
 <div class="block">Check to see if a command needs to be executed and execute if needed.</div>
 </td>
 </tr>
 <tr id="i40" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#setEnvironment-java.util.Map-">setEnvironment</a></span>(<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>&lt;<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>&gt;&nbsp;env)</code>
 <div class="block">Set the environment for the command.</div>
 </td>
 </tr>
 <tr id="i41" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.html#setWorkingDirectory-java.io.File-">setWorkingDirectory</a></span>(<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>&nbsp;dir)</code>
 <div class="block">Set the working directory.</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&nbsp;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="LOG">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>LOG</h4>
 <pre>public static final&nbsp;org.slf4j.Logger LOG</pre>
 </li>
 </ul>
 <a name="SYSPROP_HADOOP_HOME_DIR">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SYSPROP_HADOOP_HOME_DIR</h4>
 <pre>public static final&nbsp;<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> SYSPROP_HADOOP_HOME_DIR</pre>
 <div class="block">System property for the Hadoop home directory: "hadoop.home.dir".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.SYSPROP_HADOOP_HOME_DIR">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="ENV_HADOOP_HOME">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ENV_HADOOP_HOME</h4>
 <pre>public static final&nbsp;<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> ENV_HADOOP_HOME</pre>
 <div class="block">Environment variable for Hadoop's home dir: "HADOOP_HOME".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.ENV_HADOOP_HOME">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="WINDOWS_MAX_SHELL_LENGTH">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>WINDOWS_MAX_SHELL_LENGTH</h4>
 <pre>public static final&nbsp;int WINDOWS_MAX_SHELL_LENGTH</pre>
 <div class="block">Maximum command line length in Windows
  KB830473 documents this as 8191</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.WINDOWS_MAX_SHELL_LENGTH">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="WINDOWS_MAX_SHELL_LENGHT">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>WINDOWS_MAX_SHELL_LENGHT</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
 public static final&nbsp;int WINDOWS_MAX_SHELL_LENGHT</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use the correctly spelled constant.</span></div>
 <div class="block">mis-spelling of <a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS_MAX_SHELL_LENGTH"><code>WINDOWS_MAX_SHELL_LENGTH</code></a>.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.WINDOWS_MAX_SHELL_LENGHT">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="USER_NAME_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>USER_NAME_COMMAND</h4>
 <pre>public static final&nbsp;<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_NAME_COMMAND</pre>
 <div class="block">a Unix command to get the current user's name: "whoami".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.USER_NAME_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="WindowsProcessLaunchLock">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>WindowsProcessLaunchLock</h4>
 <pre>public static final&nbsp;<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> WindowsProcessLaunchLock</pre>
 <div class="block">Windows <code>CreateProcess</code> synchronization object.</div>
 </li>
 </ul>
 <a name="osType">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>osType</h4>
 <pre>public static final&nbsp;org.apache.hadoop.util.Shell.OSType osType</pre>
 <div class="block">Get the type of the operating system, as determined from parsing
  the <code>os.name</code> property.</div>
 </li>
 </ul>
 <a name="WINDOWS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>WINDOWS</h4>
 <pre>public static final&nbsp;boolean WINDOWS</pre>
 </li>
 </ul>
 <a name="SOLARIS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SOLARIS</h4>
 <pre>public static final&nbsp;boolean SOLARIS</pre>
 </li>
 </ul>
 <a name="MAC">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>MAC</h4>
 <pre>public static final&nbsp;boolean MAC</pre>
 </li>
 </ul>
 <a name="FREEBSD">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>FREEBSD</h4>
 <pre>public static final&nbsp;boolean FREEBSD</pre>
 </li>
 </ul>
 <a name="LINUX">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>LINUX</h4>
 <pre>public static final&nbsp;boolean LINUX</pre>
 </li>
 </ul>
 <a name="OTHER">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>OTHER</h4>
 <pre>public static final&nbsp;boolean OTHER</pre>
 </li>
 </ul>
 <a name="PPC_64">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PPC_64</h4>
 <pre>public static final&nbsp;boolean PPC_64</pre>
 </li>
 </ul>
 <a name="ENV_NAME_REGEX">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ENV_NAME_REGEX</h4>
 <pre>public static final&nbsp;<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> ENV_NAME_REGEX</pre>
 <div class="block">Regular expression for environment variables: "[A-Za-z_][A-Za-z0-9_]*".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.ENV_NAME_REGEX">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="SET_PERMISSION_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SET_PERMISSION_COMMAND</h4>
 <pre>public static final&nbsp;<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> SET_PERMISSION_COMMAND</pre>
 <div class="block">a Unix command to set permission: "chmod".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.SET_PERMISSION_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="SET_OWNER_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SET_OWNER_COMMAND</h4>
 <pre>public static final&nbsp;<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> SET_OWNER_COMMAND</pre>
 <div class="block">a Unix command to set owner: "chown".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.SET_OWNER_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="SET_GROUP_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SET_GROUP_COMMAND</h4>
 <pre>public static final&nbsp;<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> SET_GROUP_COMMAND</pre>
 <div class="block">a Unix command to set the change user's groups list: "chgrp".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.SET_GROUP_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="LINK_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>LINK_COMMAND</h4>
 <pre>public static final&nbsp;<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> LINK_COMMAND</pre>
 <div class="block">a Unix command to create a link: "ln".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.LINK_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="READ_LINK_COMMAND">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>READ_LINK_COMMAND</h4>
 <pre>public static final&nbsp;<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> READ_LINK_COMMAND</pre>
 <div class="block">a Unix command to get a link target: "readlink".</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.hadoop.util.Shell.READ_LINK_COMMAND">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="timeOutInterval">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>timeOutInterval</h4>
 <pre>protected&nbsp;long timeOutInterval</pre>
 <div class="block">Time after which the executing script would be timedout.</div>
 </li>
 </ul>
 <a name="inheritParentEnv">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>inheritParentEnv</h4>
 <pre>protected&nbsp;boolean inheritParentEnv</pre>
 <div class="block">Indicates if the parent env vars should be inherited or not</div>
 </li>
 </ul>
 <a name="WINUTILS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>WINUTILS</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
 public static final&nbsp;<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> WINUTILS</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use one of the exception-raising getter methods,
  specifically <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsPath--"><code>getWinUtilsPath()</code></a> or <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsFile--"><code>getWinUtilsFile()</code></a></span></div>
 <div class="block">Location of winutils as a string; null if not found.
  <p>
  <i>Important: caller must check for this value being null</i>.
  The lack of such checks has led to many support issues being raised.
  <p></div>
 </li>
 </ul>
 <a name="isSetsidAvailable">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isSetsidAvailable</h4>
 <pre>public static final&nbsp;boolean isSetsidAvailable</pre>
 <div class="block">Flag which is true if setsid exists.</div>
 </li>
 </ul>
 <a name="TOKEN_SEPARATOR_REGEX">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>TOKEN_SEPARATOR_REGEX</h4>
 <pre>public static final&nbsp;<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_SEPARATOR_REGEX</pre>
 <div class="block">Token separator regex used to parse Shell tool outputs.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="Shell--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>Shell</h4>
 <pre>protected&nbsp;Shell()</pre>
 <div class="block">Create an instance with no minimum interval between runs; stderr is
  not merged with stdout.</div>
 </li>
 </ul>
 <a name="Shell-long-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>Shell</h4>
 <pre>protected&nbsp;Shell(long&nbsp;interval)</pre>
 <div class="block">Create an instance with a minimum interval between executions; stderr is
  not merged with stdout.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>interval</code> - interval in milliseconds between command executions.</dd>
 </dl>
 </li>
 </ul>
 <a name="Shell-long-boolean-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>Shell</h4>
 <pre>protected&nbsp;Shell(long&nbsp;interval,
                 boolean&nbsp;redirectErrorStream)</pre>
 <div class="block">Create a shell instance which can be re-executed when the <a href="../../../../org/apache/hadoop/util/Shell.html#run--"><code>run()</code></a>
  method is invoked with a given elapsed time between calls.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>interval</code> - the minimum duration in milliseconds to wait before
         re-executing the command. If set to 0, there is no minimum.</dd>
 <dd><code>redirectErrorStream</code> - should the error stream be merged with
         the normal output stream?</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="isJava7OrAbove--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isJava7OrAbove</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
 public static&nbsp;boolean&nbsp;isJava7OrAbove()</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This call isn't needed any more: please remove uses of it.</span></div>
 <div class="block">query to see if system is Java 7 or later.
  Now that Hadoop requires Java 7 or later, this always returns true.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true, always.</dd>
 </dl>
 </li>
 </ul>
 <a name="isJavaVersionAtLeast-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isJavaVersionAtLeast</h4>
 <pre>public static&nbsp;boolean&nbsp;isJavaVersionAtLeast(int&nbsp;version)</pre>
 <div class="block">Query to see if major version of Java specification of the system
  is equal or greater than the parameter.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>version</code> - 8, 9, 10 etc.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>comparison with system property, always true for 8</dd>
 </dl>
 </li>
 </ul>
 <a name="checkWindowsCommandLineLength-java.lang.String...-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkWindowsCommandLineLength</h4>
 <pre>public static&nbsp;void&nbsp;checkWindowsCommandLineLength(<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>...&nbsp;commands)
                                           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">Checks if a given command (String[]) fits in the Windows maximum command
  line length Note that the input is expected to already include space
  delimiters, no extra count will be added for delimiters.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>commands</code> - command parts, including any space delimiters</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>
 </dl>
 </li>
 </ul>
 <a name="getGroupsCommand--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getGroupsCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getGroupsCommand()</pre>
 <div class="block">a Unix command to get the current user's groups list.</div>
 </li>
 </ul>
 <a name="getGroupsForUserCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getGroupsForUserCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getGroupsForUserCommand(<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>&nbsp;user)</pre>
 <div class="block">A command to get a given user's groups list.
  If the OS is not WINDOWS, the command will get the user's primary group
  first and finally get the groups list which includes the primary group.
  i.e. the user's primary group will be included twice.</div>
 </li>
 </ul>
 <a name="getGroupsIDForUserCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getGroupsIDForUserCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getGroupsIDForUserCommand(<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>&nbsp;user)</pre>
 <div class="block">A command to get a given user's group id list.
  The command will get the user's primary group
  first and finally get the groups list which includes the primary group.
  i.e. the user's primary group will be included twice.
  This command does not support Windows and will only return group names.</div>
 </li>
 </ul>
 <a name="getUsersForNetgroupCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUsersForNetgroupCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getUsersForNetgroupCommand(<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>&nbsp;netgroup)</pre>
 <div class="block">A command to get a given netgroup's user list.</div>
 </li>
 </ul>
 <a name="getGetPermissionCommand--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getGetPermissionCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getGetPermissionCommand()</pre>
 <div class="block">Return a command to get permission information.</div>
 </li>
 </ul>
 <a name="getSetPermissionCommand-java.lang.String-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSetPermissionCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getSetPermissionCommand(<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>&nbsp;perm,
                                                boolean&nbsp;recursive)</pre>
 <div class="block">Return a command to set permission.</div>
 </li>
 </ul>
 <a name="getSetPermissionCommand-java.lang.String-boolean-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSetPermissionCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getSetPermissionCommand(<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>&nbsp;perm,
                                                boolean&nbsp;recursive,
                                                <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>&nbsp;file)</pre>
 <div class="block">Return a command to set permission for specific file.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>perm</code> - String permission to set</dd>
 <dd><code>recursive</code> - boolean true to apply to all sub-directories recursively</dd>
 <dd><code>file</code> - String file to set</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>String[] containing command and arguments</dd>
 </dl>
 </li>
 </ul>
 <a name="getSetOwnerCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSetOwnerCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getSetOwnerCommand(<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>&nbsp;owner)</pre>
 <div class="block">Return a command to set owner.</div>
 </li>
 </ul>
 <a name="getSymlinkCommand-java.lang.String-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSymlinkCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getSymlinkCommand(<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>&nbsp;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>&nbsp;link)</pre>
 <div class="block">Return a command to create symbolic links.</div>
 </li>
 </ul>
 <a name="getReadlinkCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getReadlinkCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getReadlinkCommand(<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>&nbsp;link)</pre>
 <div class="block">Return a command to read the target of the a symbolic link.</div>
 </li>
 </ul>
 <a name="getCheckProcessIsAliveCommand-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCheckProcessIsAliveCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getCheckProcessIsAliveCommand(<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>&nbsp;pid)</pre>
 <div class="block">Return a command for determining if process with specified pid is alive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>pid</code> - process ID</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <code>kill -0</code> command or equivalent</dd>
 </dl>
 </li>
 </ul>
 <a name="getSignalKillCommand-int-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSignalKillCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getSignalKillCommand(int&nbsp;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>&nbsp;pid)</pre>
 <div class="block">Return a command to send a signal to a given pid.</div>
 </li>
 </ul>
 <a name="getEnvironmentVariableRegex--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getEnvironmentVariableRegex</h4>
 <pre>public static&nbsp;<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>&nbsp;getEnvironmentVariableRegex()</pre>
 <div class="block">Return a regular expression string that match environment variables.</div>
 </li>
 </ul>
 <a name="appendScriptExtension-java.io.File-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>appendScriptExtension</h4>
 <pre>public static&nbsp;<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>&nbsp;appendScriptExtension(<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>&nbsp;parent,
                                          <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>&nbsp;basename)</pre>
 <div class="block">Returns a File referencing a script with the given basename, inside the
  given parent directory.  The file extension is inferred by platform:
  <code>".cmd"</code> on Windows, or <code>".sh"</code> otherwise.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>parent</code> - File parent directory</dd>
 <dd><code>basename</code> - String script file basename</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>File referencing the script in the directory</dd>
 </dl>
 </li>
 </ul>
 <a name="appendScriptExtension-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>appendScriptExtension</h4>
 <pre>public static&nbsp;<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>&nbsp;appendScriptExtension(<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>&nbsp;basename)</pre>
 <div class="block">Returns a script file name with the given basename.

  The file extension is inferred by platform:
  <code>".cmd"</code> on Windows, or <code>".sh"</code> otherwise.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>basename</code> - String script file basename</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>String script file name</dd>
 </dl>
 </li>
 </ul>
 <a name="getRunScriptCommand-java.io.File-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRunScriptCommand</h4>
 <pre>public static&nbsp;<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>[]&nbsp;getRunScriptCommand(<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>&nbsp;script)</pre>
 <div class="block">Returns a command to run the given script.  The script interpreter is
  inferred by platform: cmd on Windows or bash otherwise.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>script</code> - File script to run</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>String[] command to run the script</dd>
 </dl>
 </li>
 </ul>
 <a name="getHadoopHome--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHadoopHome</h4>
 <pre>public static&nbsp;<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>&nbsp;getHadoopHome()
                             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">Get the Hadoop home directory. Raises an exception if not found</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the home dir</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 home directory cannot be located.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQualifiedBin-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQualifiedBin</h4>
 <pre>public static&nbsp;<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>&nbsp;getQualifiedBin(<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>&nbsp;executable)
                             throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></pre>
 <div class="block">Fully qualify the path to a binary that should be in a known hadoop
   bin location. This is primarily useful for disambiguating call-outs
   to executable sub-components of Hadoop to avoid clashes with other
   executables that may be in the path.  Caveat:  this call doesn't
   just format the path to the bin directory.  It also checks for file
   existence of the composed path. The output of this call should be
   cached by callers.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>executable</code> - executable</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>executable file reference</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path does not exist</dd>
 </dl>
 </li>
 </ul>
 <a name="getQualifiedBinPath-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQualifiedBinPath</h4>
 <pre>public static&nbsp;<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>&nbsp;getQualifiedBinPath(<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>&nbsp;executable)
                                   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">Fully qualify the path to a binary that should be in a known hadoop
   bin location. This is primarily useful for disambiguating call-outs
   to executable sub-components of Hadoop to avoid clashes with other
   executables that may be in the path.  Caveat:  this call doesn't
   just format the path to the bin directory.  It also checks for file
   existence of the composed path. The output of this call should be
   cached by callers.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>executable</code> - executable</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>executable file reference</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path does not exist</dd>
 <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> - on path canonicalization failures</dd>
 </dl>
 </li>
 </ul>
 <a name="hasWinutilsPath--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hasWinutilsPath</h4>
 <pre>public static&nbsp;boolean&nbsp;hasWinutilsPath()</pre>
 <div class="block">Predicate to indicate whether or not the path to winutils is known.

  If true, then <a href="../../../../org/apache/hadoop/util/Shell.html#WINUTILS"><code>WINUTILS</code></a> is non-null, and both
  <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsPath--"><code>getWinUtilsPath()</code></a> and <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsFile--"><code>getWinUtilsFile()</code></a>
  will successfully return this value. Always false on non-windows systems.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if there is a valid path to the binary</dd>
 </dl>
 </li>
 </ul>
 <a name="getWinUtilsPath--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getWinUtilsPath</h4>
 <pre>public static&nbsp;<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>&nbsp;getWinUtilsPath()</pre>
 <div class="block">Locate the winutils binary, or fail with a meaningful
  exception and stack trace as an RTE.
  This method is for use in methods which don't explicitly throw
  an <code>IOException</code>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the path to <a href="../../../../org/apache/hadoop/util/Shell.html#WINUTILS_EXE"><code>WINUTILS_EXE</code></a></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the path is not resolvable</dd>
 </dl>
 </li>
 </ul>
 <a name="getWinUtilsFile--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getWinUtilsFile</h4>
 <pre>public static&nbsp;<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>&nbsp;getWinUtilsFile()
                             throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></pre>
 <div class="block">Get a file reference to winutils.
  Always raises an exception if there isn't one</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the file instance referring to the winutils bin.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - on any failure to locate that file.</dd>
 </dl>
 </li>
 </ul>
 <a name="checkIsBashSupported--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkIsBashSupported</h4>
 <pre>public static&nbsp;boolean&nbsp;checkIsBashSupported()
                                     throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io">InterruptedIOException</a></pre>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io">InterruptedIOException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="setEnvironment-java.util.Map-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setEnvironment</h4>
 <pre>protected&nbsp;void&nbsp;setEnvironment(<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>&lt;<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>&gt;&nbsp;env)</pre>
 <div class="block">Set the environment for the command.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>env</code> - Mapping of environment variables</dd>
 </dl>
 </li>
 </ul>
 <a name="setWorkingDirectory-java.io.File-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setWorkingDirectory</h4>
 <pre>protected&nbsp;void&nbsp;setWorkingDirectory(<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>&nbsp;dir)</pre>
 <div class="block">Set the working directory.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dir</code> - The directory where the command will be executed</dd>
 </dl>
 </li>
 </ul>
 <a name="run--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>run</h4>
 <pre>protected&nbsp;void&nbsp;run()
             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 to see if a command needs to be executed and execute if needed.</div>
 <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="getExecString--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecString</h4>
 <pre>protected abstract&nbsp;<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>[]&nbsp;getExecString()</pre>
 <div class="block">return an array containing the command name and its parameters.</div>
 </li>
 </ul>
 <a name="parseExecResult-java.io.BufferedReader-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>parseExecResult</h4>
 <pre>protected abstract&nbsp;void&nbsp;parseExecResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/BufferedReader.html?is-external=true" title="class or interface in java.io">BufferedReader</a>&nbsp;lines)
                                  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">Parse the execution result</div>
 <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="getEnvironment-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getEnvironment</h4>
 <pre>public&nbsp;<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>&nbsp;getEnvironment(<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>&nbsp;env)</pre>
 <div class="block">Get an environment variable.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>env</code> - the environment var</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the value or null if it was unset.</dd>
 </dl>
 </li>
 </ul>
 <a name="getProcess--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getProcess</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Process.html?is-external=true" title="class or interface in java.lang">Process</a>&nbsp;getProcess()</pre>
 <div class="block">get the current sub-process executing the given command.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>process executing the command</dd>
 </dl>
 </li>
 </ul>
 <a name="getExitCode--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExitCode</h4>
 <pre>public&nbsp;int&nbsp;getExitCode()</pre>
 <div class="block">get the exit code.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the exit code of the process</dd>
 </dl>
 </li>
 </ul>
 <a name="getWaitingThread--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getWaitingThread</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a>&nbsp;getWaitingThread()</pre>
 <div class="block">get the thread that is waiting on this instance of <code>Shell</code>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the thread that ran runCommand() that spawned this shell
  or null if no thread is waiting for this shell to complete</dd>
 </dl>
 </li>
 </ul>
 <a name="isTimedOut--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isTimedOut</h4>
 <pre>public&nbsp;boolean&nbsp;isTimedOut()</pre>
 <div class="block">To check if the passed script to shell command executor timed out or
  not.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>if the script timed out.</dd>
 </dl>
 </li>
 </ul>
 <a name="execCommand-java.lang.String...-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>execCommand</h4>
 <pre>public static&nbsp;<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>&nbsp;execCommand(<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>...&nbsp;cmd)
                           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">Static method to execute a shell command.
  Covers most of the simple cases without requiring the user to implement
  the <code>Shell</code> interface.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cmd</code> - shell command to execute.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the output of the executed command.</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>
 </dl>
 </li>
 </ul>
 <a name="execCommand-java.util.Map-java.lang.String:A-long-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>execCommand</h4>
 <pre>public static&nbsp;<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>&nbsp;execCommand(<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>&lt;<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>&gt;&nbsp;env,
                                  <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>[]&nbsp;cmd,
                                  long&nbsp;timeout)
                           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">Static method to execute a shell command.
  Covers most of the simple cases without requiring the user to implement
  the <code>Shell</code> interface.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>env</code> - the map of environment key=value</dd>
 <dd><code>cmd</code> - shell command to execute.</dd>
 <dd><code>timeout</code> - time in milliseconds after which script should be marked timeout</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the output of the executed command.</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> - on any problem.</dd>
 </dl>
 </li>
 </ul>
 <a name="execCommand-java.util.Map-java.lang.String...-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>execCommand</h4>
 <pre>public static&nbsp;<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>&nbsp;execCommand(<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>&lt;<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>&gt;&nbsp;env,
                                  <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>...&nbsp;cmd)
                           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">Static method to execute a shell command.
  Covers most of the simple cases without requiring the user to implement
  the <code>Shell</code> interface.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>env</code> - the map of environment key=value</dd>
 <dd><code>cmd</code> - shell command to execute.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the output of the executed command.</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> - on any problem.</dd>
 </dl>
 </li>
 </ul>
 <a name="destroyAllShellProcesses--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>destroyAllShellProcesses</h4>
 <pre>public static&nbsp;void&nbsp;destroyAllShellProcesses()</pre>
 <div class="block">Static method to destroy all running <code>Shell</code> processes.
  Iterates through a map of all currently running <code>Shell</code>
  processes and destroys them one by one. This method is thread safe</div>
 </li>
 </ul>
 <a name="getAllShells--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAllShells</h4>
 <pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a>&gt;&nbsp;getAllShells()</pre>
 <div class="block">Static method to return a Set of all <code>Shell</code> objects.</div>
 </li>
 </ul>
 <a name="getMemlockLimit-java.lang.Long-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getMemlockLimit</h4>
 <pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;getMemlockLimit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;ulimit)</pre>
 <div class="block">Static method to return the memory lock limit for datanode.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ulimit</code> - max value at which memory locked should be capped.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>long value specifying the memory lock limit.</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/Shell.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/util/ReflectionUtils.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/hadoop/util/ShutdownHookManager.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/hadoop/util/Shell.html" target="_top">Frames</a></li>
 <li><a href="Shell.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>