org.apache.tools.ant.taskdefs.optional.net

Class TelnetTask

public class TelnetTask extends Task

Automates the telnet protocol.
Nested Class Summary
classTelnetTask.AntTelnetClient
This class handles the abstraction of the telnet protocol.
classTelnetTask.TelnetRead
Reads the output from the connected server until the required string is found or we time out.
classTelnetTask.TelnetSubTask
This class is the parent of the Read and Write tasks.
classTelnetTask.TelnetWrite
Sends text to the connected server
Method Summary
TelnetTask.TelnetSubTaskcreateRead()
A string to wait for from the server.
TelnetTask.TelnetSubTaskcreateWrite()
Add text to send to the server A subTask <write> tag was found.
voidexecute()
Verify that all parameters are included.
voidsetInitialCR(boolean b)
send a carriage return after connecting; optional, defaults to false.
voidsetPassword(String p)
Set the the login password to use required if userid is set.
voidsetPort(int p)
Set the tcp port to connect to; default is 23.
voidsetServer(String m)
Set the hostname or address of the remote server.
voidsetTimeout(Integer i)
set a default timeout in seconds to wait for a response, zero means forever (the default)
voidsetUserid(String u)
Set the the login id to use on the server; required if password is set.

Method Detail

createRead

public TelnetTask.TelnetSubTask createRead()
A string to wait for from the server. A subTask <read> tag was found. Create the object, Save it in our list, and return it.

Returns: a read telnet sub task

createWrite

public TelnetTask.TelnetSubTask createWrite()
Add text to send to the server A subTask <write> tag was found. Create the object, Save it in our list, and return it.

Returns: a write telnet sub task

execute

public void execute()
Verify that all parameters are included. Connect and possibly login Iterate through the list of Reads and writes

Throws: BuildException on error

setInitialCR

public void setInitialCR(boolean b)
send a carriage return after connecting; optional, defaults to false.

Parameters: b a boolean value

setPassword

public void setPassword(String p)
Set the the login password to use required if userid is set.

Parameters: p a String value

setPort

public void setPort(int p)
Set the tcp port to connect to; default is 23.

Parameters: p an int value

setServer

public void setServer(String m)
Set the hostname or address of the remote server.

Parameters: m a String value

setTimeout

public void setTimeout(Integer i)
set a default timeout in seconds to wait for a response, zero means forever (the default)

Parameters: i an Integer value

setUserid

public void setUserid(String u)
Set the the login id to use on the server; required if password is set.

Parameters: u a String value