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