Class TelnetTask
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.Task
-
- org.apache.tools.ant.taskdefs.optional.net.TelnetTask
-
- All Implemented Interfaces:
java.lang.Cloneable
public class TelnetTask extends Task
Automates the telnet protocol.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classTelnetTask.AntTelnetClientThis class handles the abstraction of the telnet protocol.classTelnetTask.TelnetReadReads the output from the connected server until the required string is found or we time out.classTelnetTask.TelnetSubTaskThis class is the parent of the Read and Write tasks.classTelnetTask.TelnetWriteSends text to the connected server
-
Field Summary
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description TelnetTask()
-
Method Summary
Modifier and Type Method Description 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(java.lang.String p)Set the the login password to use required ifuseridis set.voidsetPort(int p)Set the tcp port to connect to; default is 23.voidsetServer(java.lang.String m)Set the hostname or address of the remote server.voidsetTimeout(java.lang.Integer i)set a default timeout in seconds to wait for a response, zero means forever (the default)voidsetUserid(java.lang.String u)Set the the login id to use on the server; required ifpasswordis set.-
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
-
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
-
-
-
Method Detail
-
execute
public void execute() throws BuildExceptionVerify that all parameters are included. Connect and possibly login Iterate through the list of Reads and writes- Overrides:
executein classTask- Throws:
BuildException- on error
-
setUserid
public void setUserid(java.lang.String u)
Set the the login id to use on the server; required ifpasswordis set.- Parameters:
u- aStringvalue
-
setPassword
public void setPassword(java.lang.String p)
Set the the login password to use required ifuseridis set.- Parameters:
p- aStringvalue
-
setServer
public void setServer(java.lang.String m)
Set the hostname or address of the remote server.- Parameters:
m- aStringvalue
-
setPort
public void setPort(int p)
Set the tcp port to connect to; default is 23.- Parameters:
p- anintvalue
-
setInitialCR
public void setInitialCR(boolean b)
send a carriage return after connecting; optional, defaults to false.- Parameters:
b- abooleanvalue
-
setTimeout
public void setTimeout(java.lang.Integer i)
set a default timeout in seconds to wait for a response, zero means forever (the default)- Parameters:
i- anIntegervalue
-
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
-
-