|
SSH Factory | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.jscape.inet.telnet.TelnetSession
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 |
getLoginPrompt()
Gets login prompt to wait for before sending username. |
java.lang.String |
getPasswordPrompt()
Gets password prompt to wait for before sending password. |
int |
getPort()
Gets the port of the telnet server. |
java.lang.String |
getShellPrompt()
Gets shell prompt to wait for before sending commands. |
Telnet |
getTelnet()
Gets underlying Telnet instance |
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 |
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 |
setPort(int i)
Sets the port of the telnet server |
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 |
public TelnetSession(java.lang.String hostname)
hostname - the hostname of telnet server
public TelnetSession(java.lang.String hostname,
boolean listener)
hostname - the hostname of telnet serverlistener - automatically register a telnet listener and reject any option negotiation
public TelnetSession(java.lang.String hostname,
java.lang.String characterSet)
hostname - the hostname of telnet servercharacterSet - the character set to use when reading data from telnet server
public TelnetSession(java.lang.String hostname,
java.lang.String characterSet,
boolean listener)
hostname - the hostname of telnet servercharacterSet - the character set to use when reading data from telnet serverlistener - automatically register a telnet listener and reject any option negotiation
public TelnetSession(java.lang.String hostname,
int port,
boolean listener)
hostname - the hostname of telnet serverport - the port of telnet serverlistener - automatically register a telnet listener and reject any option negotiation
public TelnetSession(java.lang.String hostname,
int port)
hostname - the hostname of telnet serverport - the port of telnet server
public TelnetSession(java.lang.String hostname,
int port,
java.lang.String characterSet)
hostname - the hostname of the telnet serverport - the port of the telnet servercharacterSet - the character set
public TelnetSession(java.lang.String hostname,
int port,
java.lang.String characterSet,
boolean listener)
hostname - the hostname of the telnet serverport - the port of the telnet servercharacterSet - the character setlistener - automatically register a telnet listener and reject any option negotiation| Method Detail |
public void connect(java.lang.String username,
java.lang.String password,
int timeout)
throws TelnetException
username - the username or null if no login prompt is displayedpassword - the password or null if no password prompt is displayedtimeout - the timeout in milliseconds for opening connection to telnet server.
TelnetException - if a telnet or I/O related error occurs
public void connect(java.lang.String username,
java.lang.String password)
throws TelnetException
username - the username or null if no login prompt is displayedpassword - the password or null if no password prompt is displayed
TelnetException - if a telnet or I/O related error occurs
public java.lang.String send(java.lang.String command,
long timeout)
throws TelnetException
command - the command to sendtimeout - the timeout to use when waiting for task end prompt
TelnetException - if regular expression prompts are used and regular expression is invalidsetShellPrompt(java.lang.String),
setCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public java.lang.String send(java.lang.String command)
throws TelnetException
command - the command to send
TelnetException - if regular expression prompts are used and regular expression is invalidsetShellPrompt(java.lang.String),
setCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public java.lang.String sendWait(java.lang.String command,
java.lang.String prompt,
long timeout)
throws TelnetException
command - the command to sendprompt - the prompt to wait fortimeout - the timeout to use when waiting for task end prompt
TelnetException - if regular expression prompts are used and regular expression is invalidsetCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public java.lang.String sendWait(java.lang.String command,
java.lang.String prompt,
boolean regex,
long timeout)
throws TelnetException
command - the command to sendprompt - the prompt to wait forregex - true if prompt to match is a regular expression, false otherwisetimeout - the timeout to use when waiting for task end prompt
TelnetException - if regular expression prompts are used and regular expression is invalidsetCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public java.lang.String sendWait(java.lang.String command,
java.lang.String prompt)
throws TelnetException
command - the command to sendprompt - the prompt to wait for
TelnetException - if regular expression prompts are used and regular expression is invalidsetCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public java.lang.String sendWait(java.lang.String command,
java.lang.String prompt,
boolean regex)
throws TelnetException
command - the command to sendprompt - the prompt to wait forregex - true if prompt to match is a regular expression, false otherwise
TelnetException - if regular expression prompts are used and regular expression is invalidsetCommandTerminator(java.lang.String),
TelnetTaskTimeoutException
public void sendNoWait(java.lang.String command)
throws java.io.IOException
command - the command to send
java.io.IOException - if an I/O related error occurssetCommandTerminator(java.lang.String)
public void sendRaw(java.lang.String data)
throws java.io.IOException
data - the data to send
java.io.IOException - if an I/O related error occurssetCommandTerminator(java.lang.String)
public void disconnect()
throws TelnetException
TelnetException - if a telnet or I/O related error occurspublic java.lang.String getLoginPrompt()
public java.lang.String getPasswordPrompt()
public java.lang.String getShellPrompt()
public void setLoginPrompt(java.lang.String string)
string - the login prompt
public void setLoginPrompt(java.lang.String loginPrompt,
boolean regex)
regex - true if prompt to match is a regular expression, false otherwisepublic void setPasswordPrompt(java.lang.String string)
string - the password prompt
public void setPasswordPrompt(java.lang.String string,
boolean regex)
string - the password promptregex - true if prompt to match is a regular expression, false otherwisepublic void setShellPrompt(java.lang.String string)
string - the shell prompt
public void setShellPrompt(java.lang.String string,
boolean regex)
string - the shell promptregex - true if prompt to match is a regular expression, false otherwisepublic boolean isDebug()
public void debug(java.lang.String msg)
msg - the debug message to sendsetDebugStream(java.io.PrintStream)public void setDebug(boolean b)
b - true to enable debugging, false to disablesetDebugStream(java.io.PrintStream)public void setDebugStream(java.io.PrintStream stream)
stream - a PrintStreampublic java.io.PrintStream getDebugStream()
setDebug(boolean),
setDebugStream(java.io.PrintStream)public java.lang.String getCommandTerminator()
public void setCommandTerminator(java.lang.String string)
string - the command terminatorpublic int getPort()
public void setPort(int i)
i - the portpublic void addTelnetListener(TelnetListener listener)
listener - a TelnetListenerTelnetListenerpublic void removeTelnetListener(TelnetListener listener)
listener - a TelnetListenerTelnetListenerpublic void pause(long timeout)
timeout - time in millisecondspublic Telnet getTelnet()
|
SSH Factory | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||