| <!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:01:50 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Shell.ShellCommandExecutor (Apache Hadoop Common 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.ShellCommandExecutor (Apache Hadoop Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Shell.ShellCommandExecutor.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/Shell.OSType.html" title="enum in org.apache.hadoop.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/util/ShutdownHookManager.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/util/Shell.ShellCommandExecutor.html" target="_top">Frames</a></li> |
| <li><a href="Shell.ShellCommandExecutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.hadoop.util.Shell">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.util.Shell">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.util</div> |
| <h2 title="Class Shell.ShellCommandExecutor" class="title">Class Shell.ShellCommandExecutor</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><a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">org.apache.hadoop.util.Shell</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.util.Shell.ShellCommandExecutor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">Shell.ShellCommandExecutor</span> |
| extends <a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a> |
| implements <a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></pre> |
| <div class="block">A simple shell command executor. |
| |
| <code>ShellCommandExecutor</code>should be used in cases where the output |
| of the command needs no explicit parsing and where the command, working |
| directory and the environment remains unchanged. The output of the command |
| is stored as-is and is expected to be small.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.util.Shell"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.hadoop.util.<a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a>, <a href="../../../../org/apache/hadoop/util/Shell.ExitCodeException.html" title="class in org.apache.hadoop.util">Shell.ExitCodeException</a>, <a href="../../../../org/apache/hadoop/util/Shell.OSType.html" title="enum in org.apache.hadoop.util">Shell.OSType</a>, <a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html" title="class in org.apache.hadoop.util">Shell.ShellCommandExecutor</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.util.Shell"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.util.<a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/util/Shell.html#ENV_HADOOP_HOME">ENV_HADOOP_HOME</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#ENV_NAME_REGEX">ENV_NAME_REGEX</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#FREEBSD">FREEBSD</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#inheritParentEnv">inheritParentEnv</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#isSetsidAvailable">isSetsidAvailable</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#LINK_COMMAND">LINK_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#LINUX">LINUX</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#LOG">LOG</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#MAC">MAC</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#osType">osType</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#OTHER">OTHER</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#PPC_64">PPC_64</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#READ_LINK_COMMAND">READ_LINK_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#SET_GROUP_COMMAND">SET_GROUP_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#SET_OWNER_COMMAND">SET_OWNER_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#SET_PERMISSION_COMMAND">SET_PERMISSION_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#SOLARIS">SOLARIS</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#SYSPROP_HADOOP_HOME_DIR">SYSPROP_HADOOP_HOME_DIR</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#timeOutInterval">timeOutInterval</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#TOKEN_SEPARATOR_REGEX">TOKEN_SEPARATOR_REGEX</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#USER_NAME_COMMAND">USER_NAME_COMMAND</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS">WINDOWS</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS_MAX_SHELL_LENGHT">WINDOWS_MAX_SHELL_LENGHT</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#WINDOWS_MAX_SHELL_LENGTH">WINDOWS_MAX_SHELL_LENGTH</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#WindowsProcessLaunchLock">WindowsProcessLaunchLock</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#WINUTILS">WINUTILS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#ShellCommandExecutor-java.lang.String:A-">ShellCommandExecutor</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>[] execString)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#ShellCommandExecutor-java.lang.String:A-java.io.File-">ShellCommandExecutor</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>[] execString, |
| <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> dir)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-">ShellCommandExecutor</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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-long-">ShellCommandExecutor</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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env, |
| long timeout)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-long-boolean-">ShellCommandExecutor</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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env, |
| long timeout, |
| boolean inheritParentEnv)</code> |
| <div class="block">Create a new instance of the ShellCommandExecutor to execute a command.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#execute--">execute</a></span>()</code> |
| <div class="block">Execute the shell command.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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.ShellCommandExecutor.html#getExecString--">getExecString</a></span>()</code> |
| <div class="block">return an array containing the command name and its parameters.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#getOutput--">getOutput</a></span>()</code> |
| <div class="block">Get the output of the shell command.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#getTimeoutInterval--">getTimeoutInterval</a></span>()</code> |
| <div class="block">Returns the timeout value set for the executor's sub-commands.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.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> lines)</code> |
| <div class="block">Parse the execution result</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/Shell.ShellCommandExecutor.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns the commands of this instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.util.Shell"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.util.<a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/util/Shell.html#appendScriptExtension-java.io.File-java.lang.String-">appendScriptExtension</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#appendScriptExtension-java.lang.String-">appendScriptExtension</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#checkIsBashSupported--">checkIsBashSupported</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#checkWindowsCommandLineLength-java.lang.String...-">checkWindowsCommandLineLength</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#destroyAllShellProcesses--">destroyAllShellProcesses</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#execCommand-java.util.Map-java.lang.String...-">execCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#execCommand-java.util.Map-java.lang.String:A-long-">execCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#execCommand-java.lang.String...-">execCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getAllShells--">getAllShells</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getCheckProcessIsAliveCommand-java.lang.String-">getCheckProcessIsAliveCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getEnvironment-java.lang.String-">getEnvironment</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getEnvironmentVariableRegex--">getEnvironmentVariableRegex</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getExitCode--">getExitCode</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getGetPermissionCommand--">getGetPermissionCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getGroupsCommand--">getGroupsCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getGroupsForUserCommand-java.lang.String-">getGroupsForUserCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getGroupsIDForUserCommand-java.lang.String-">getGroupsIDForUserCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getHadoopHome--">getHadoopHome</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getMemlockLimit-java.lang.Long-">getMemlockLimit</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getProcess--">getProcess</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getQualifiedBin-java.lang.String-">getQualifiedBin</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getQualifiedBinPath-java.lang.String-">getQualifiedBinPath</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getReadlinkCommand-java.lang.String-">getReadlinkCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getRunScriptCommand-java.io.File-">getRunScriptCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getSetOwnerCommand-java.lang.String-">getSetOwnerCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getSetPermissionCommand-java.lang.String-boolean-">getSetPermissionCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getSetPermissionCommand-java.lang.String-boolean-java.lang.String-">getSetPermissionCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getSignalKillCommand-int-java.lang.String-">getSignalKillCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getSymlinkCommand-java.lang.String-java.lang.String-">getSymlinkCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getUsersForNetgroupCommand-java.lang.String-">getUsersForNetgroupCommand</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getWaitingThread--">getWaitingThread</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsFile--">getWinUtilsFile</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#getWinUtilsPath--">getWinUtilsPath</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#hasWinutilsPath--">hasWinutilsPath</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#isJava7OrAbove--">isJava7OrAbove</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#isJavaVersionAtLeast-int-">isJavaVersionAtLeast</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#isTimedOut--">isTimedOut</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#run--">run</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#setEnvironment-java.util.Map-">setEnvironment</a>, <a href="../../../../org/apache/hadoop/util/Shell.html#setWorkingDirectory-java.io.File-">setWorkingDirectory</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.util.Shell.CommandExecutor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.util.<a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></h3> |
| <code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html#getExitCode--">getExitCode</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ShellCommandExecutor-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ShellCommandExecutor</h4> |
| <pre>public ShellCommandExecutor(<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>[] execString)</pre> |
| </li> |
| </ul> |
| <a name="ShellCommandExecutor-java.lang.String:A-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ShellCommandExecutor</h4> |
| <pre>public ShellCommandExecutor(<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>[] execString, |
| <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> dir)</pre> |
| </li> |
| </ul> |
| <a name="ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ShellCommandExecutor</h4> |
| <pre>public ShellCommandExecutor(<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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</pre> |
| </li> |
| </ul> |
| <a name="ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ShellCommandExecutor</h4> |
| <pre>public ShellCommandExecutor(<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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env, |
| long timeout)</pre> |
| </li> |
| </ul> |
| <a name="ShellCommandExecutor-java.lang.String:A-java.io.File-java.util.Map-long-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ShellCommandExecutor</h4> |
| <pre>public ShellCommandExecutor(<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>[] execString, |
| <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> dir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env, |
| long timeout, |
| boolean inheritParentEnv)</pre> |
| <div class="block">Create a new instance of the ShellCommandExecutor to execute a command.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>execString</code> - The command to execute with arguments</dd> |
| <dd><code>dir</code> - If not-null, specifies the directory which should be set |
| as the current working directory for the command. |
| If null, the current working directory is not modified.</dd> |
| <dd><code>env</code> - If not-null, environment of the command will include the |
| key-value pairs specified in the map. If null, the current |
| environment is not modified.</dd> |
| <dd><code>timeout</code> - Specifies the time in milliseconds, after which the |
| command will be killed and the status marked as timed-out. |
| If 0, the command will not be timed out.</dd> |
| <dd><code>inheritParentEnv</code> - Indicates if the process should inherit the env |
| vars from the parent process or not.</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="getTimeoutInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeoutInterval</h4> |
| <pre>public long getTimeoutInterval()</pre> |
| <div class="block">Returns the timeout value set for the executor's sub-commands.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The timeout value in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public void execute() |
| 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">Execute the shell command.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html#execute--">execute</a></code> in interface <code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></code></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 command fails, or if the command is |
| not well constructed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExecString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getExecString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/hadoop/util/Shell.html#getExecString--">Shell</a></code></span></div> |
| <div class="block">return an array containing the command name and its parameters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/util/Shell.html#getExecString--">getExecString</a></code> in class <code><a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseExecResult-java.io.BufferedReader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseExecResult</h4> |
| <pre>protected void 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> 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/hadoop/util/Shell.html#parseExecResult-java.io.BufferedReader-">Shell</a></code></span></div> |
| <div class="block">Parse the execution result</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/util/Shell.html#parseExecResult-java.io.BufferedReader-">parseExecResult</a></code> in class <code><a href="../../../../org/apache/hadoop/util/Shell.html" title="class in org.apache.hadoop.util">Shell</a></code></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="getOutput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutput</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOutput()</pre> |
| <div class="block">Get the output of the shell command.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html#getOutput--">getOutput</a></code> in interface <code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">Returns the commands of this instance. |
| Arguments with spaces in are presented with quotes round; other |
| arguments are presented raw</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of the object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/hadoop/util/Shell.CommandExecutor.html" title="interface in org.apache.hadoop.util">Shell.CommandExecutor</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Shell.ShellCommandExecutor.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/Shell.OSType.html" title="enum in org.apache.hadoop.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/util/ShutdownHookManager.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/util/Shell.ShellCommandExecutor.html" target="_top">Frames</a></li> |
| <li><a href="Shell.ShellCommandExecutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.hadoop.util.Shell">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.util.Shell">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |