Class TelnetWrapper

Class TelnetWrapper 

java.lang.Object
   |
   +----TelnetWrapper
public class TelnetWrapper
extends Object
Wrapper for a Java Telnet call. Supports remote commands. Uses code from Matthias L. Jugel's and Marcus Meißner's freeware Telnet Applet. Note - their Applet is under GNU copyleft, so any commercial use of this code is restricted. See their above site for details.
Author:
George Ruban 3/4/97
See Also:
TelnetIO

Variable Index

o tio
The telnet connection.

Constructor Index

o TelnetWrapper(String)
Connects to the default telnet port on the given host.

Method Index

o disconnect()
Ends the telnet connection.
o finalize()
Ends the telnet connection.
o login(String, String)
Logs in as a particular user and password.
o main(String[])
Telnet test driver.
o receive()
Returns a String from the telnet connection.
o receiveBytes()
Returns a byte array.
o receiveUntil(String)
Returns all data received up until a certain token.
o send(byte[])
Sends bytes over the telnet connection.
o send(String)
Sends a String to the remote host.
o sendLine(String)
Sends a line to the remote host, returns all data before the prompt.
o setDefaultPrompt(String)
Sets the default prompt used by all TelnetWrappers.
o setLogin(String, String)
Sets the default login used by TelnetWrappers.
o setPrompt(String)
Sets the expected prompt.
o unsetLogin()
Turns off the default login of TelnetWrappers.
o wait(String)
Skip any received data until the token appears.

Variables

o tio 
  protected TelnetIO tio
The telnet connection. That which is wrapped.

Constructors

o TelnetWrapper 
  public TelnetWrapper(String host) throws IOException
Connects to the default telnet port on the given host.

Methods

o wait 
  public void wait(String token) throws IOException
Skip any received data until the token appears.
o receive 
  public String receive() throws IOException
Returns a String from the telnet connection. Blocks until one is available. No guarantees that the string is in any way complete. NOTE: uses Java 1.0.2 style String-bytes conversion.
o receiveBytes 
  public byte[] receiveBytes() throws IOException
Returns a byte array. Blocks until data is available.
o receiveUntil 
  public String receiveUntil(String token) throws IOException
Returns all data received up until a certain token.
o send 
  public void send(String s) throws IOException
Sends a String to the remote host. NOTE: uses Java 1.0.2 style String-bytes conversion.
o sendLine 
  public String sendLine(String command) throws IOException
Sends a line to the remote host, returns all data before the prompt. Since telnet seems to rely on carriage returns ('\r'), one will be appended to the sent string, if necessary.
Parameters:
command - command line to send
Returns:
whatever data the command produced before the prompt.
See Also:
setPrompt
o send 
  public void send(byte buf[]) throws IOException
Sends bytes over the telnet connection.
o login 
  public void login(String loginName,
                    String password) throws IOException
Logs in as a particular user and password. Returns after receiving prompt.
o setPrompt 
  public void setPrompt(String prompt)
Sets the expected prompt. If this function is not explicitly called, the default prompt is used.
See Also:
setDefaultPrompt
o setDefaultPrompt 
  public static void setDefaultPrompt(String prompt)
Sets the default prompt used by all TelnetWrappers. This can be specifically overridden for a specific instance. The default prompt starts out as "$ " until this function is called.
See Also:
setPrompt
o setLogin 
  public static void setLogin(String login,
                              String password)
Sets the default login used by TelnetWrappers. If this method is called with non-null login and password, all TelnetWrappers will attempt to login when first created.
Parameters:
login - login name to use
password - password to use
See Also:
login, unsetLogin
o unsetLogin 
  public static void unsetLogin()
Turns off the default login of TelnetWrappers. After this method is called, TelnetWrappers will not login until that method is explicitly called.
See Also:
setLogin, login
o disconnect 
  public void disconnect() throws IOException
Ends the telnet connection.
o finalize 
  public void finalize()
Ends the telnet connection.
Overrides:
finalize in class Object
o main 
  public static void main(String args[]) throws IOException
Telnet test driver. Modeled after the IOtest.java example in the Telnet Applet. Logs in to stems, creates a timestamped file in /tmp, lists the /tmp directory to System.out, disconnects. Shows off several TelnetWrapper methods.