source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 24.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:30 NZST 2007 -->
6<TITLE>
7SSHExec (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ssh.SSHExec class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="SSHExec (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="SSHExec.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.ssh</FONT>
85<BR>
86Class SSHExec</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">org.apache.tools.ant.taskdefs.optional.ssh.SSHBase</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ssh.SSHExec</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>SSHExec</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</A></DL>
100
101<P>
102Executes a command on a remote machine via ssh.
103<P>
104
105<P>
106<DL>
107<DT><B>Since:</B></DT>
108 <DD>Ant 1.6</DD>
109</DL>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115
116<!-- =========== FIELD SUMMARY =========== -->
117
118<A NAME="field_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Field Summary</B></FONT></TD>
123</TR>
124</TABLE>
125&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
128<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
132</TR>
133</TABLE>
134&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
137<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- ======== CONSTRUCTOR SUMMARY ======== -->
145
146<A NAME="constructor_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TD COLSPAN=2><FONT SIZE="+2">
150<B>Constructor Summary</B></FONT></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#SSHExec()">SSHExec</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for SSHExecTask.</TD>
157</TR>
158</TABLE>
159&nbsp;
160<!-- ========== METHOD SUMMARY =========== -->
161
162<A NAME="method_summary"><!-- --></A>
163<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
164<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
165<TD COLSPAN=2><FONT SIZE="+2">
166<B>Method Summary</B></FONT></TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#execute()">execute</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the command on the remote host.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#setAppend(boolean)">setAppend</A></B>(boolean&nbsp;append)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the output is appended to the file given in
183 <code>setOutput</code>.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;void</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#setCommand(java.lang.String)">setCommand</A></B>(java.lang.String&nbsp;command)</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the command to execute on the remote host.</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>&nbsp;void</CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#setOutput(java.io.File)">setOutput</A></B>(java.io.File&nbsp;output)</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If used, stores the output of the command to the given file.</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>&nbsp;void</CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#setOutputproperty(java.lang.String)">setOutputproperty</A></B>(java.lang.String&nbsp;property)</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If set, the output of the command will be stored in the given property.</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>&nbsp;void</CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html#setTimeout(long)">setTimeout</A></B>(long&nbsp;timeout)</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The connection can be dropped after a specified number of
216 milliseconds.</TD>
217</TR>
218</TABLE>
219&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.SSHBase"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
222<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</A></B></TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getFailonerror()">getFailonerror</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getHost()">getHost</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getPort()">getPort</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getUserInfo()">getUserInfo</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getVerbose()">getVerbose</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#openSession()">openSession</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setFailonerror(boolean)">setFailonerror</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setHost(java.lang.String)">setHost</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKeyfile(java.lang.String)">setKeyfile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKnownhosts(java.lang.String)">setKnownhosts</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassphrase(java.lang.String)">setPassphrase</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassword(java.lang.String)">setPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPort(int)">setPort</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setTrust(boolean)">setTrust</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setUsername(java.lang.String)">setUsername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setVerbose(boolean)">setVerbose</A></CODE></TD>
226</TR>
227</TABLE>
228&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
231<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
235</TR>
236</TABLE>
237&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
240<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
244</TR>
245</TABLE>
246&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
249<TD><B>Methods inherited from class java.lang.Object</B></TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
253</TR>
254</TABLE>
255&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.LogListener"><!-- --></A>
256<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
257<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
258<TD><B>Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</A></B></TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html#log(java.lang.String)">log</A></CODE></TD>
262</TR>
263</TABLE>
264&nbsp;
265<P>
266
267<!-- ============ FIELD DETAIL =========== -->
268
269
270<!-- ========= CONSTRUCTOR DETAIL ======== -->
271
272<A NAME="constructor_detail"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
275<TD COLSPAN=1><FONT SIZE="+2">
276<B>Constructor Detail</B></FONT></TD>
277</TR>
278</TABLE>
279
280<A NAME="SSHExec()"><!-- --></A><H3>
281SSHExec</H3>
282<PRE>
283public <B>SSHExec</B>()</PRE>
284<DL>
285<DD>Constructor for SSHExecTask.
286<P>
287</DL>
288
289<!-- ============ METHOD DETAIL ========== -->
290
291<A NAME="method_detail"><!-- --></A>
292<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
293<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
294<TD COLSPAN=1><FONT SIZE="+2">
295<B>Method Detail</B></FONT></TD>
296</TR>
297</TABLE>
298
299<A NAME="setCommand(java.lang.String)"><!-- --></A><H3>
300setCommand</H3>
301<PRE>
302public void <B>setCommand</B>(java.lang.String&nbsp;command)</PRE>
303<DL>
304<DD>Sets the command to execute on the remote host.
305<P>
306<DD><DL>
307<DT><B>Parameters:</B><DD><CODE>command</CODE> - The new command value</DL>
308</DD>
309</DL>
310<HR>
311
312<A NAME="setTimeout(long)"><!-- --></A><H3>
313setTimeout</H3>
314<PRE>
315public void <B>setTimeout</B>(long&nbsp;timeout)</PRE>
316<DL>
317<DD>The connection can be dropped after a specified number of
318 milliseconds. This is sometimes useful when a connection may be
319 flaky. Default is 0, which means &quot;wait forever&quot;.
320<P>
321<DD><DL>
322<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - The new timeout value in seconds</DL>
323</DD>
324</DL>
325<HR>
326
327<A NAME="setOutput(java.io.File)"><!-- --></A><H3>
328setOutput</H3>
329<PRE>
330public void <B>setOutput</B>(java.io.File&nbsp;output)</PRE>
331<DL>
332<DD>If used, stores the output of the command to the given file.
333<P>
334<DD><DL>
335<DT><B>Parameters:</B><DD><CODE>output</CODE> - The file to write to.</DL>
336</DD>
337</DL>
338<HR>
339
340<A NAME="setAppend(boolean)"><!-- --></A><H3>
341setAppend</H3>
342<PRE>
343public void <B>setAppend</B>(boolean&nbsp;append)</PRE>
344<DL>
345<DD>Determines if the output is appended to the file given in
346 <code>setOutput</code>. Default is false, that is, overwrite
347 the file.
348<P>
349<DD><DL>
350<DT><B>Parameters:</B><DD><CODE>append</CODE> - True to append to an existing file, false to overwrite.</DL>
351</DD>
352</DL>
353<HR>
354
355<A NAME="setOutputproperty(java.lang.String)"><!-- --></A><H3>
356setOutputproperty</H3>
357<PRE>
358public void <B>setOutputproperty</B>(java.lang.String&nbsp;property)</PRE>
359<DL>
360<DD>If set, the output of the command will be stored in the given property.
361<P>
362<DD><DL>
363<DT><B>Parameters:</B><DD><CODE>property</CODE> - The name of the property in which the command output
364 will be stored.</DL>
365</DD>
366</DL>
367<HR>
368
369<A NAME="execute()"><!-- --></A><H3>
370execute</H3>
371<PRE>
372public void <B>execute</B>()
373 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
374<DL>
375<DD>Execute the command on the remote host.
376<P>
377<DD><DL>
378<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
379</DD>
380<DD><DL>
381
382<DT><B>Throws:</B>
383<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - Most likely a network error or bad parameter.</DL>
384</DD>
385</DL>
386<!-- ========= END OF CLASS DATA ========= -->
387<HR>
388
389
390<!-- ======= START OF BOTTOM NAVBAR ====== -->
391<A NAME="navbar_bottom"><!-- --></A>
392<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
393<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
394<TR>
395<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
396<A NAME="navbar_bottom_firstrow"><!-- --></A>
397<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
398 <TR ALIGN="center" VALIGN="top">
399 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
400 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
401 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
402 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
403 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
404 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
405 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
406 </TR>
407</TABLE>
408</TD>
409<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
410</EM>
411</TD>
412</TR>
413
414<TR>
415<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
416&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
417&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
418<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
419 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
420&nbsp;<A HREF="SSHExec.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
421&nbsp;<SCRIPT type="text/javascript">
422 <!--
423 if(window==top) {
424 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
425 }
426 //-->
427</SCRIPT>
428<NOSCRIPT>
429 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
430</NOSCRIPT>
431
432</FONT></TD>
433</TR>
434<TR>
435<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
436 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
437<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
438DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
439</TR>
440</TABLE>
441<A NAME="skip-navbar_bottom"></A>
442<!-- ======== END OF BOTTOM NAVBAR ======= -->
443
444<HR>
445Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
446</BODY>
447</HTML>
Note: See TracBrowser for help on using the repository browser.