TelnetSession (SSH Factory API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SSH Factory

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jscape.inet.telnet
Class TelnetSession

java.lang.Object
  com.jscape.inet.telnet.TelnetSession

public class TelnetSession
extends java.lang.Object
extends java.lang.Object

Convenience class for automating communications with a Telnet server.

Example:

 String hostname = "10.0.0.2";
 String loginPrompt = "login:";
 String passwordPrompt = "Password:"
 String shellPrompt = "$";

 // create new TelnetSession instance providing hostname as argument
 TelnetSession session = new TelnetSession(hostname);

 // set the expected login prompt
 session.setLoginPrompt(loginPrompt);

 // set the expected password prompt
 session.setPasswordPrompt(passwordPrompt);

 // set the expected shell prompt
 session.setShellPrompt(shellPrompt); *

 // connect and login using supplied username and password
 session.connect(username,password);

 // send command to telnet server and wait for shell prompt
 session.send("cd /user/logs");

 // send command to telnet server and wait for shell prompt
 session.send("rm *.log");

 // send command to telnet server and DO NOT wait for shell prompt
 session.sendNoWait("exit");

 // close connection with telnet server
 session.disconnect();

Constructor Summary
`TelnetSession(java.lang.String hostname)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, boolean listener)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, int port)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, int port, boolean listener)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, int port, java.lang.String characterSet)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, int port, java.lang.String characterSet, boolean listener)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, java.lang.String characterSet)` Creates a new TelnetSession instance.
`TelnetSession(java.lang.String hostname, java.lang.String characterSet, boolean listener)` Creates a new TelnetSession instance.

Method Summary
`void`	`addTelnetListener(TelnetListener listener)` Add telnet event listener.
`void`	`connect(java.lang.String username, java.lang.String password)` Establishes connection with telnet server and performs login using specified username and password.
`void`	`connect(java.lang.String username, java.lang.String password, int timeout)` Establishes connection with telnet server and performs login using specified username and password.
`void`	`debug(java.lang.String msg)` Sends debug message to debug stream.
`void`	`disconnect()` Disconnects from telnet server.
`java.lang.String`	`getCommandTerminator()` Gets terminator used when sending data to telnet server.
`java.io.PrintStream`	`getDebugStream()` Gets PrintStream used in outputting debug information.
`java.lang.String`	`getHostname()` Gets the hostname of telnet server.
`java.lang.String`	`getLoginPrompt()` Gets login prompt to wait for before sending username.
`java.lang.String`	`getPasswordPrompt()` Gets password prompt to wait for before sending password.
`int`	`getPollingInterval()` Gets the polling interval used when checking for completion of commands sent using send or sendWait methods.
`int`	`getPort()` Gets the port of the telnet server.
`int`	`getRegexMatchLength()` Gets the number of characters to read from the end of the response buffer when using regular expressions to detect start or end prompts.
`java.lang.String`	`getShellPrompt()` Gets shell prompt to wait for before sending commands.
`Telnet`	`getTelnet()` Gets underlying Telnet instance.
`void`	`interrupt()` Interrupts any running command waiting for an expected prompt.
`boolean`	`isDebug()` Checks if debugging is enabled.
`void`	`pause(long timeout)` Pauses current session for specified timeout.
`void`	`removeTelnetListener(TelnetListener listener)` Remove telnet event listener.
`java.lang.String`	`send(java.lang.String command)` Sends command to telnet host terminated by command terminator.
`java.lang.String`	`send(java.lang.String command, long timeout)` Sends command to telnet host terminated by command terminator.
`void`	`sendNoWait(java.lang.String command)` Sends command to telnet host terminated by command terminator.
`void`	`sendRaw(java.lang.String data)` Sends data to telnet host without command terminator.
`java.lang.String`	`sendWait(java.lang.String command, java.lang.String prompt)` Sends command to telnet host terminated by command terminator.
`java.lang.String`	`sendWait(java.lang.String command, java.lang.String prompt, boolean regex)` Sends command to telnet host terminated by command terminator.
`java.lang.String`	`sendWait(java.lang.String command, java.lang.String prompt, boolean regex, long timeout)` Sends command to telnet host terminated by command terminator.
`java.lang.String`	`sendWait(java.lang.String command, java.lang.String prompt, long timeout)` Sends command to telnet host terminated by command terminator.
`void`	`setCommandTerminator(java.lang.String string)` Sets terminator used when sending data to telnet server.
`void`	`setDebug(boolean b)` Enables or disables debugging information.
`void`	`setDebugStream(java.io.PrintStream stream)` Sets PrintStream used in outputting debug information.
`void`	`setHostname(java.lang.String hostname)` Sets the hostname of telnet server.
`void`	`setLoginPrompt(java.lang.String string)` Sets login prompt to wait for before sending username.
`void`	`setLoginPrompt(java.lang.String loginPrompt, boolean regex)` Sets login prompt to wait for before sending username.
`void`	`setPasswordPrompt(java.lang.String string)` Sets password prompt to wait for before sending password.
`void`	`setPasswordPrompt(java.lang.String string, boolean regex)` Sets password prompt to wait for before sending password.
`void`	`setPollingInterval(int pollingInterval)` Sets the polling interval used when checking for completion of commands sent using send or sendWait methods.
`void`	`setPort(int i)` Sets the port of the telnet server.
`void`	`setRegexMatchLength(int regexMatchLength)` Sets the number of characters to read from the end of the response buffer when using regular expressions to detect start or end prompts.
`void`	`setShellPrompt(java.lang.String string)` Sets shell prompt to wait for before sending commands.
`void`	`setShellPrompt(java.lang.String string, boolean regex)` Sets shell prompt to wait for before sending commands.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail