source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/net/RExecTask.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 25.8 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:29 NZST 2007 -->
6<TITLE>
7RExecTask (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.RExecTask 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="RExecTask (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/net/MimeMail.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><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="RExecTask.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;<A HREF="#nested_class_summary">NESTED</A>&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.net</FONT>
85<BR>
86Class RExecTask</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"><B>org.apache.tools.ant.taskdefs.optional.net.RExecTask</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>RExecTask</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Automates the rexec protocol.
99<P>
100
101<P>
102<DL>
103<DT><B>Since:</B></DT>
104 <DD>Ant 1.6</DD>
105</DL>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111<A NAME="nested_class_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TD COLSPAN=2><FONT SIZE="+2">
115<B>Nested Class Summary</B></FONT></TD>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>&nbsp;class</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.AntRExecClient</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class handles the abstraction of the rexec protocol.</TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>&nbsp;class</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecRead</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the output from the connected server
132 until the required string is found or we time out.</TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>&nbsp;class</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecSubTask</A></B></CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class is the parent of the Read and Write tasks.</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;class</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecWrite</A></B></CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends text to the connected server</TD>
149</TR>
150</TABLE>
151&nbsp;
152<!-- =========== FIELD SUMMARY =========== -->
153
154<A NAME="field_summary"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157<TD COLSPAN=2><FONT SIZE="+2">
158<B>Field Summary</B></FONT></TD>
159</TR>
160</TABLE>
161&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<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>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<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>
168</TR>
169</TABLE>
170&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<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>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ======== CONSTRUCTOR SUMMARY ======== -->
181
182<A NAME="constructor_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=2><FONT SIZE="+2">
186<B>Constructor Summary</B></FONT></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#RExecTask()">RExecTask</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
193</TR>
194</TABLE>
195&nbsp;
196<!-- ========== METHOD SUMMARY =========== -->
197
198<A NAME="method_summary"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TD COLSPAN=2><FONT SIZE="+2">
202<B>Method Summary</B></FONT></TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecSubTask</A></CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#createRead()">createRead</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string to wait for from the server.</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecSubTask</A></CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#createWrite()">createWrite</A></B>()</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add text to send to the server
219 A subTask &lt;write&gt; tag was found.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;void</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#execute()">execute</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verify that all parameters are included.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setCommand(java.lang.String)">setCommand</A></B>(java.lang.String&nbsp;c)</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the the comand to execute on the server;</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;void</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setInitialCR(boolean)">setInitialCR</A></B>(boolean&nbsp;b)</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;send a carriage return after connecting; optional, defaults to false.</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<CODE>&nbsp;void</CODE></FONT></TD>
248<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String&nbsp;p)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the the login password to use
252 required if <tt>userid</tt> is set.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setPort(int)">setPort</A></B>(int&nbsp;p)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the tcp port to connect to; default is 23.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setServer(java.lang.String)">setServer</A></B>(java.lang.String&nbsp;m)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the hostname or address of the remote server.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setTimeout(java.lang.Integer)">setTimeout</A></B>(java.lang.Integer&nbsp;i)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set a default timeout in seconds to wait for a response,
277 zero means forever (the default)</TD>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281<CODE>&nbsp;void</CODE></FONT></TD>
282<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html#setUserid(java.lang.String)">setUserid</A></B>(java.lang.String&nbsp;u)</CODE>
283
284<BR>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the the login id to use on the server;
286 required if <tt>password</tt> is set.</TD>
287</TR>
288</TABLE>
289&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
290<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
292<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>
293</TR>
294<TR BGCOLOR="white" CLASS="TableRowColor">
295<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#init()">init</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>
296</TR>
297</TABLE>
298&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
299<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
300<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
301<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>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<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>
305</TR>
306</TABLE>
307&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
308<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
309<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
310<TD><B>Methods inherited from class java.lang.Object</B></TD>
311</TR>
312<TR BGCOLOR="white" CLASS="TableRowColor">
313<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
314</TR>
315</TABLE>
316&nbsp;
317<P>
318
319<!-- ============ FIELD DETAIL =========== -->
320
321
322<!-- ========= CONSTRUCTOR DETAIL ======== -->
323
324<A NAME="constructor_detail"><!-- --></A>
325<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
326<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
327<TD COLSPAN=1><FONT SIZE="+2">
328<B>Constructor Detail</B></FONT></TD>
329</TR>
330</TABLE>
331
332<A NAME="RExecTask()"><!-- --></A><H3>
333RExecTask</H3>
334<PRE>
335public <B>RExecTask</B>()</PRE>
336<DL>
337</DL>
338
339<!-- ============ METHOD DETAIL ========== -->
340
341<A NAME="method_detail"><!-- --></A>
342<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
343<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
344<TD COLSPAN=1><FONT SIZE="+2">
345<B>Method Detail</B></FONT></TD>
346</TR>
347</TABLE>
348
349<A NAME="createRead()"><!-- --></A><H3>
350createRead</H3>
351<PRE>
352public <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecSubTask</A> <B>createRead</B>()</PRE>
353<DL>
354<DD>A string to wait for from the server.
355 A subTask &lt;read&gt; tag was found. Create the object,
356 Save it in our list, and return it.
357<P>
358<DD><DL>
359</DL>
360</DD>
361</DL>
362<HR>
363
364<A NAME="createWrite()"><!-- --></A><H3>
365createWrite</H3>
366<PRE>
367public <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask.RExecSubTask</A> <B>createWrite</B>()</PRE>
368<DL>
369<DD>Add text to send to the server
370 A subTask &lt;write&gt; tag was found. Create the object,
371 Save it in our list, and return it.
372<P>
373<DD><DL>
374</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="execute()"><!-- --></A><H3>
380execute</H3>
381<PRE>
382public void <B>execute</B>()
383 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
384<DL>
385<DD>Verify that all parameters are included.
386 Connect and possibly login
387 Iterate through the list of Reads and writes
388<P>
389<DD><DL>
390<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>
391</DD>
392<DD><DL>
393
394<DT><B>Throws:</B>
395<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
396</DD>
397</DL>
398<HR>
399
400<A NAME="setCommand(java.lang.String)"><!-- --></A><H3>
401setCommand</H3>
402<PRE>
403public void <B>setCommand</B>(java.lang.String&nbsp;c)</PRE>
404<DL>
405<DD>Set the the comand to execute on the server;
406<P>
407<DD><DL>
408</DL>
409</DD>
410</DL>
411<HR>
412
413<A NAME="setInitialCR(boolean)"><!-- --></A><H3>
414setInitialCR</H3>
415<PRE>
416public void <B>setInitialCR</B>(boolean&nbsp;b)</PRE>
417<DL>
418<DD>send a carriage return after connecting; optional, defaults to false.
419<P>
420<DD><DL>
421</DL>
422</DD>
423</DL>
424<HR>
425
426<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
427setPassword</H3>
428<PRE>
429public void <B>setPassword</B>(java.lang.String&nbsp;p)</PRE>
430<DL>
431<DD>Set the the login password to use
432 required if <tt>userid</tt> is set.
433<P>
434<DD><DL>
435</DL>
436</DD>
437</DL>
438<HR>
439
440<A NAME="setPort(int)"><!-- --></A><H3>
441setPort</H3>
442<PRE>
443public void <B>setPort</B>(int&nbsp;p)</PRE>
444<DL>
445<DD>Set the tcp port to connect to; default is 23.
446<P>
447<DD><DL>
448</DL>
449</DD>
450</DL>
451<HR>
452
453<A NAME="setServer(java.lang.String)"><!-- --></A><H3>
454setServer</H3>
455<PRE>
456public void <B>setServer</B>(java.lang.String&nbsp;m)</PRE>
457<DL>
458<DD>Set the hostname or address of the remote server.
459<P>
460<DD><DL>
461</DL>
462</DD>
463</DL>
464<HR>
465
466<A NAME="setTimeout(java.lang.Integer)"><!-- --></A><H3>
467setTimeout</H3>
468<PRE>
469public void <B>setTimeout</B>(java.lang.Integer&nbsp;i)</PRE>
470<DL>
471<DD>set a default timeout in seconds to wait for a response,
472 zero means forever (the default)
473<P>
474<DD><DL>
475</DL>
476</DD>
477</DL>
478<HR>
479
480<A NAME="setUserid(java.lang.String)"><!-- --></A><H3>
481setUserid</H3>
482<PRE>
483public void <B>setUserid</B>(java.lang.String&nbsp;u)</PRE>
484<DL>
485<DD>Set the the login id to use on the server;
486 required if <tt>password</tt> is set.
487<P>
488<DD><DL>
489</DL>
490</DD>
491</DL>
492<!-- ========= END OF CLASS DATA ========= -->
493<HR>
494
495
496<!-- ======= START OF BOTTOM NAVBAR ====== -->
497<A NAME="navbar_bottom"><!-- --></A>
498<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
499<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
500<TR>
501<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
502<A NAME="navbar_bottom_firstrow"><!-- --></A>
503<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
504 <TR ALIGN="center" VALIGN="top">
505 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
506 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
507 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
508 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
509 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
510 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
511 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
512 </TR>
513</TABLE>
514</TD>
515<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
516</EM>
517</TD>
518</TR>
519
520<TR>
521<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
522&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/MimeMail.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
523&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
524<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
525 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
526&nbsp;<A HREF="RExecTask.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
527&nbsp;<SCRIPT type="text/javascript">
528 <!--
529 if(window==top) {
530 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
531 }
532 //-->
533</SCRIPT>
534<NOSCRIPT>
535 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
536</NOSCRIPT>
537
538</FONT></TD>
539</TR>
540<TR>
541<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
542 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&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>
543<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
544DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
545</TR>
546</TABLE>
547<A NAME="skip-navbar_bottom"></A>
548<!-- ======== END OF BOTTOM NAVBAR ======= -->
549
550<HR>
551Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
552</BODY>
553</HTML>
Note: See TracBrowser for help on using the repository browser.