Google Git
Sign in
eclipse / gerrit / ptp / org.eclipse.ptp / 244dae6e1b4c7ab0d70ab60465b8a1cb387c1007 / . / core / org.eclipse.ptp.doc.isv / reference / api / org / eclipse / ptp / remote / core / IRemoteProcessBuilder.html
blob: afcdb15a1d9a2b3bf1071b6e126f26895e40c23d [file] [log] [blame]
<!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 (version 1.7.0_21) on Wed Jun 12 19:57:03 BST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1">
<title>IRemoteProcessBuilder (PTP API Specification)</title>
<meta name="date" content="2013-06-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IRemoteProcessBuilder (PTP API Specification)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/IRemoteProcessBuilder.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteResource.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" target="_top">Frames</a></li>
<li><a href="IRemoteProcessBuilder.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.eclipse.ptp.remote.core</div>
<h2 title="Interface IRemoteProcessBuilder" class="title">Interface IRemoteProcessBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/ptp/remote/core/AbstractRemoteProcessBuilder.html" title="class in org.eclipse.ptp.remote.core">AbstractRemoteProcessBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IRemoteProcessBuilder</span></pre>
<div class="block">Abstraction of a process builder for remote processes. This interface behaves in the same manner as
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ProcessBuilder.html?is-external=true" title="class or interface in java.lang"><code>ProcessBuilder</code></a>.</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="overviewSummary" 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 int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#ALLOCATE_PTY">ALLOCATE_PTY</a></strong></code>
<div class="block">Flag to request allocation of a pseudo-terminal for the process (RFC-4254
Sec. 6.2)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#FORWARD_X11">FORWARD_X11</a></strong></code>
<div class="block">Flag to request X11 forwarding (RFC-4254 Sec. 6.3)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#NONE">NONE</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#command()">command</a></strong>()</code>
<div class="block">Returns this process builder's operating system program and arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#command(java.util.List)">command</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;command)</code>
<div class="block">Sets this process builder's operating system program and arguments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#command(java.lang.String...)">command</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;command)</code>
<div class="block">Sets this process builder's operating system program and arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#connection()">connection</a></strong>()</code>
<div class="block">Returns this process builder's connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#connection(org.eclipse.ptp.remote.core.IRemoteConnection)">connection</a></strong>(<a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a>&nbsp;conn)</code>
<div class="block">Sets this process builder's connection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>IFileStore</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#directory()">directory</a></strong>()</code>
<div class="block">Returns this process builder's working directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#directory(IFileStore)">directory</a></strong>(IFileStore&nbsp;directory)</code>
<div class="block">Sets this process builder's working directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#environment()">environment</a></strong>()</code>
<div class="block">Returns a string map view of this process builder's environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#getSupportedFlags()">getSupportedFlags</a></strong>()</code>
<div class="block">Get the flags that are supported by this process builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#redirectErrorStream()">redirectErrorStream</a></strong>()</code>
<div class="block">Tells whether this process builder merges standard error and standard
output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#redirectErrorStream(boolean)">redirectErrorStream</a></strong>(boolean&nbsp;redirectErrorStream)</code>
<div class="block">Sets this process builder's redirectErrorStream property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcess</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#start()">start</a></strong>()</code>
<div class="block">Starts a new process using the attributes of this process builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcess</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#start(int)">start</a></strong>(int&nbsp;flags)</code>
<div class="block">Starts a new process using the attributes of this process builder.</div>
</td>
</tr>
</table>
</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="NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NONE</h4>
<pre>static final&nbsp;int NONE</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>5.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteProcessBuilder.NONE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ALLOCATE_PTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALLOCATE_PTY</h4>
<pre>static final&nbsp;int ALLOCATE_PTY</pre>
<div class="block">Flag to request allocation of a pseudo-terminal for the process (RFC-4254
Sec. 6.2)</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>5.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteProcessBuilder.ALLOCATE_PTY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FORWARD_X11">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FORWARD_X11</h4>
<pre>static final&nbsp;int FORWARD_X11</pre>
<div class="block">Flag to request X11 forwarding (RFC-4254 Sec. 6.3)</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>5.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteProcessBuilder.FORWARD_X11">Constant Field Values</a></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="command()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>command</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;command()</pre>
<div class="block">Returns this process builder's operating system program and arguments.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a list containing the program and arguments</dd></dl>
</li>
</ul>
<a name="command(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>command</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a>&nbsp;command(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;command)</pre>
<div class="block">Sets this process builder's operating system program and arguments.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>This process builder</dd></dl>
</li>
</ul>
<a name="command(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>command</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a>&nbsp;command(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;command)</pre>
<div class="block">Sets this process builder's operating system program and arguments.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>this process builder</dd></dl>
</li>
</ul>
<a name="connection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connection</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a>&nbsp;connection()</pre>
<div class="block">Returns this process builder's connection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the connection used by this process builder</dd></dl>
</li>
</ul>
<a name="connection(org.eclipse.ptp.remote.core.IRemoteConnection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connection</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a>&nbsp;connection(<a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a>&nbsp;conn)</pre>
<div class="block">Sets this process builder's connection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This process builder</dd></dl>
</li>
</ul>
<a name="directory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>directory</h4>
<pre>IFileStore&nbsp;directory()</pre>
<div class="block">Returns this process builder's working directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an IFileStore reference to the working directory</dd></dl>
</li>
</ul>
<a name="directory(IFileStore)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>directory</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a>&nbsp;directory(IFileStore&nbsp;directory)</pre>
<div class="block">Sets this process builder's working directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>This process builder</dd></dl>
</li>
</ul>
<a name="environment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>environment</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;environment()</pre>
<div class="block">Returns a string map view of this process builder's environment. The
returned map behaves in the same manner as described in <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ProcessBuilder.html?is-external=true#environment()" title="class or interface in java.lang"><code>ProcessBuilder.environment()</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the process builder's environment</dd></dl>
</li>
</ul>
<a name="getSupportedFlags()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedFlags</h4>
<pre>int&nbsp;getSupportedFlags()</pre>
<div class="block">Get the flags that are supported by this process builder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>bitwise-or of the supported flags</dd><dt><span class="strong">Since:</span></dt>
<dd>5.0</dd></dl>
</li>
</ul>
<a name="redirectErrorStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectErrorStream</h4>
<pre>boolean&nbsp;redirectErrorStream()</pre>
<div class="block">Tells whether this process builder merges standard error and standard
output.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if standard error and standard output will be merged</dd></dl>
</li>
</ul>
<a name="redirectErrorStream(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectErrorStream</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcessBuilder</a>&nbsp;redirectErrorStream(boolean&nbsp;redirectErrorStream)</pre>
<div class="block">Sets this process builder's redirectErrorStream property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>redirectErrorStream</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>This process builder</dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcess</a>&nbsp;start()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Starts a new process using the attributes of this process builder.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>remote process object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/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="start(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>start</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core">IRemoteProcess</a>&nbsp;start(int&nbsp;flags)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Starts a new process using the attributes of this process builder. The
flags may be used to modify behavior of the remote process. These flags
may only be supported by specific types of remote service providers.
Clients can use <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html#getSupportedFlags()"><code>getSupportedFlags()</code></a> to find out the flags
supported by the service provider.
<pre>
Current flags are:
NONE - disable any flags
ALLOCATE_PTY - allocate a pseudo-terminal for the process (RFC-4254 Sec. 6.2)
FORWARD_X11 - enable X11 forwarding (RFC-4254 Sec. 6.3)
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>flags</code> - bitwise-or of flags to use when starting process</dd>
<dt><span class="strong">Returns:</span></dt><dd>remote process object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">Since:</span></dt>
<dd>5.0</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/IRemoteProcessBuilder.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteProcess.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteResource.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/ptp/remote/core/IRemoteProcessBuilder.html" target="_top">Frames</a></li>
<li><a href="IRemoteProcessBuilder.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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 (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p>
</body>
</html>