[14627] | 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>
|
---|
| 7 | TelnetTask.AntTelnetClient (Apache Ant API)
|
---|
| 8 | </TITLE>
|
---|
| 9 |
|
---|
| 10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient class">
|
---|
| 11 |
|
---|
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
|
---|
| 13 |
|
---|
| 14 | <SCRIPT type="text/javascript">
|
---|
| 15 | function windowTitle()
|
---|
| 16 | {
|
---|
| 17 | parent.document.title="TelnetTask.AntTelnetClient (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> </TD>
|
---|
| 36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>
|
---|
| 53 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetRead.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>
|
---|
| 56 | <A HREF="TelnetTask.AntTelnetClient.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 57 | <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 74 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
---|
| 84 | org.apache.tools.ant.taskdefs.optional.net</FONT>
|
---|
| 85 | <BR>
|
---|
| 86 | Class TelnetTask.AntTelnetClient</H2>
|
---|
| 87 | <PRE>
|
---|
| 88 | java.lang.Object
|
---|
| 89 | <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by">TelnetClient
|
---|
| 90 | <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient</B>
|
---|
| 91 | </PRE>
|
---|
| 92 | <DL>
|
---|
| 93 | <DT><B>Enclosing class:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">TelnetTask</A></DD>
|
---|
| 94 | </DL>
|
---|
| 95 | <HR>
|
---|
| 96 | <DL>
|
---|
| 97 | <DT>public class <B>TelnetTask.AntTelnetClient</B><DT>extends TelnetClient</DL>
|
---|
| 98 |
|
---|
| 99 | <P>
|
---|
| 100 | This class handles the abstraction of the telnet protocol.
|
---|
| 101 | Currently it is a wrapper around <a
|
---|
| 102 | href="http://jakarta.apache.org/commons/net/index.html">Jakarta
|
---|
| 103 | Commons Net</a>.
|
---|
| 104 | <P>
|
---|
| 105 |
|
---|
| 106 | <P>
|
---|
| 107 | <DL>
|
---|
| 108 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../serialized-form.html#org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient">Serialized Form</A></DL>
|
---|
| 109 | <HR>
|
---|
| 110 |
|
---|
| 111 | <P>
|
---|
| 112 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
| 113 |
|
---|
| 114 |
|
---|
| 115 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
| 116 |
|
---|
| 117 |
|
---|
| 118 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
| 119 |
|
---|
| 120 | <A NAME="constructor_summary"><!-- --></A>
|
---|
| 121 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 122 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 123 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 124 | <B>Constructor Summary</B></FONT></TD>
|
---|
| 125 | </TR>
|
---|
| 126 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 127 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html#TelnetTask.AntTelnetClient()">TelnetTask.AntTelnetClient</A></B>()</CODE>
|
---|
| 128 |
|
---|
| 129 | <BR>
|
---|
| 130 | </TD>
|
---|
| 131 | </TR>
|
---|
| 132 | </TABLE>
|
---|
| 133 |
|
---|
| 134 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
| 135 |
|
---|
| 136 | <A NAME="method_summary"><!-- --></A>
|
---|
| 137 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 138 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 139 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 140 | <B>Method Summary</B></FONT></TD>
|
---|
| 141 | </TR>
|
---|
| 142 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 144 | <CODE> void</CODE></FONT></TD>
|
---|
| 145 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html#sendString(java.lang.String, boolean)">sendString</A></B>(java.lang.String s,
|
---|
| 146 | boolean echoString)</CODE>
|
---|
| 147 |
|
---|
| 148 | <BR>
|
---|
| 149 | Write this string to the telnet session.</TD>
|
---|
| 150 | </TR>
|
---|
| 151 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 152 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 153 | <CODE> void</CODE></FONT></TD>
|
---|
| 154 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html#waitForString(java.lang.String)">waitForString</A></B>(java.lang.String s)</CODE>
|
---|
| 155 |
|
---|
| 156 | <BR>
|
---|
| 157 | Read from the telnet session until the string we are
|
---|
| 158 | waiting for is found</TD>
|
---|
| 159 | </TR>
|
---|
| 160 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 161 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 162 | <CODE> void</CODE></FONT></TD>
|
---|
| 163 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html#waitForString(java.lang.String, java.lang.Integer)">waitForString</A></B>(java.lang.String s,
|
---|
| 164 | java.lang.Integer timeout)</CODE>
|
---|
| 165 |
|
---|
| 166 | <BR>
|
---|
| 167 | Read from the telnet session until the string we are
|
---|
| 168 | waiting for is found or the timeout has been reached</TD>
|
---|
| 169 | </TR>
|
---|
| 170 | </TABLE>
|
---|
| 171 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
| 172 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 173 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 174 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
| 175 | </TR>
|
---|
| 176 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 177 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
| 178 | </TR>
|
---|
| 179 | </TABLE>
|
---|
| 180 |
|
---|
| 181 | <P>
|
---|
| 182 |
|
---|
| 183 | <!-- ============ FIELD DETAIL =========== -->
|
---|
| 184 |
|
---|
| 185 |
|
---|
| 186 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
| 187 |
|
---|
| 188 | <A NAME="constructor_detail"><!-- --></A>
|
---|
| 189 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 190 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 191 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 192 | <B>Constructor Detail</B></FONT></TD>
|
---|
| 193 | </TR>
|
---|
| 194 | </TABLE>
|
---|
| 195 |
|
---|
| 196 | <A NAME="TelnetTask.AntTelnetClient()"><!-- --></A><H3>
|
---|
| 197 | TelnetTask.AntTelnetClient</H3>
|
---|
| 198 | <PRE>
|
---|
| 199 | public <B>TelnetTask.AntTelnetClient</B>()</PRE>
|
---|
| 200 | <DL>
|
---|
| 201 | </DL>
|
---|
| 202 |
|
---|
| 203 | <!-- ============ METHOD DETAIL ========== -->
|
---|
| 204 |
|
---|
| 205 | <A NAME="method_detail"><!-- --></A>
|
---|
| 206 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 207 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 208 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 209 | <B>Method Detail</B></FONT></TD>
|
---|
| 210 | </TR>
|
---|
| 211 | </TABLE>
|
---|
| 212 |
|
---|
| 213 | <A NAME="waitForString(java.lang.String)"><!-- --></A><H3>
|
---|
| 214 | waitForString</H3>
|
---|
| 215 | <PRE>
|
---|
| 216 | public void <B>waitForString</B>(java.lang.String s)</PRE>
|
---|
| 217 | <DL>
|
---|
| 218 | <DD>Read from the telnet session until the string we are
|
---|
| 219 | waiting for is found
|
---|
| 220 | <P>
|
---|
| 221 | <DD><DL>
|
---|
| 222 | <DT><B>Parameters:</B><DD><CODE>s</CODE> - The string to wait on</DL>
|
---|
| 223 | </DD>
|
---|
| 224 | </DL>
|
---|
| 225 | <HR>
|
---|
| 226 |
|
---|
| 227 | <A NAME="waitForString(java.lang.String, java.lang.Integer)"><!-- --></A><H3>
|
---|
| 228 | waitForString</H3>
|
---|
| 229 | <PRE>
|
---|
| 230 | public void <B>waitForString</B>(java.lang.String s,
|
---|
| 231 | java.lang.Integer timeout)</PRE>
|
---|
| 232 | <DL>
|
---|
| 233 | <DD>Read from the telnet session until the string we are
|
---|
| 234 | waiting for is found or the timeout has been reached
|
---|
| 235 | <P>
|
---|
| 236 | <DD><DL>
|
---|
| 237 | <DT><B>Parameters:</B><DD><CODE>s</CODE> - The string to wait on<DD><CODE>timeout</CODE> - The maximum number of seconds to wait</DL>
|
---|
| 238 | </DD>
|
---|
| 239 | </DL>
|
---|
| 240 | <HR>
|
---|
| 241 |
|
---|
| 242 | <A NAME="sendString(java.lang.String, boolean)"><!-- --></A><H3>
|
---|
| 243 | sendString</H3>
|
---|
| 244 | <PRE>
|
---|
| 245 | public void <B>sendString</B>(java.lang.String s,
|
---|
| 246 | boolean echoString)</PRE>
|
---|
| 247 | <DL>
|
---|
| 248 | <DD>Write this string to the telnet session.
|
---|
| 249 | <P>
|
---|
| 250 | <DD><DL>
|
---|
| 251 | <DT><B>Parameters:</B><DD><CODE>echoString</CODE> - Logs string sent</DL>
|
---|
| 252 | </DD>
|
---|
| 253 | </DL>
|
---|
| 254 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
| 255 | <HR>
|
---|
| 256 |
|
---|
| 257 |
|
---|
| 258 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
| 259 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
| 260 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
| 261 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
| 262 | <TR>
|
---|
| 263 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
| 264 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
| 265 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
| 266 | <TR ALIGN="center" VALIGN="top">
|
---|
| 267 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
| 268 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 269 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 270 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 271 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 272 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 273 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
| 274 | </TR>
|
---|
| 275 | </TABLE>
|
---|
| 276 | </TD>
|
---|
| 277 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
| 278 | </EM>
|
---|
| 279 | </TD>
|
---|
| 280 | </TR>
|
---|
| 281 |
|
---|
| 282 | <TR>
|
---|
| 283 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 284 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>
|
---|
| 285 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetRead.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
| 286 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 287 | <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
| 288 | <A HREF="TelnetTask.AntTelnetClient.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 289 | <SCRIPT type="text/javascript">
|
---|
| 290 | <!--
|
---|
| 291 | if(window==top) {
|
---|
| 292 | document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
| 293 | }
|
---|
| 294 | //-->
|
---|
| 295 | </SCRIPT>
|
---|
| 296 | <NOSCRIPT>
|
---|
| 297 | <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
| 298 | </NOSCRIPT>
|
---|
| 299 |
|
---|
| 300 | </FONT></TD>
|
---|
| 301 | </TR>
|
---|
| 302 | <TR>
|
---|
| 303 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 304 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 305 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 306 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
| 307 | </TR>
|
---|
| 308 | </TABLE>
|
---|
| 309 | <A NAME="skip-navbar_bottom"></A>
|
---|
| 310 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
| 311 |
|
---|
| 312 | <HR>
|
---|
| 313 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
| 314 | </BODY>
|
---|
| 315 | </HTML>
|
---|