org.apache.commons.net.telnet

Class TelnetClient

public class TelnetClient extends Telnet

The TelnetClient class implements the simple network virtual terminal (NVT) for the Telnet protocol according to RFC 854. It does not implement any of the extra Telnet options because it is meant to be used within a Java program providing automated access to Telnet accessible resources.

The class can be used by first connecting to a server using the SocketClient {@link org.apache.commons.net.SocketClient#connect connect} method. Then an InputStream and OutputStream for sending and receiving data over the Telnet connection can be obtained by using the {@link #getInputStream getInputStream() } and {@link #getOutputStream getOutputStream() } methods. When you finish using the streams, you must call {@link #disconnect disconnect } rather than simply closing the streams.

Author: Daniel F. Savarese Bruno D'Avanzo

Field Summary
protected boolean	readerThread

Constructor Summary
	TelnetClient() Default TelnetClient constructor.
	TelnetClient(String termtype)

Method Summary
void	addOptionHandler(TelnetOptionHandler opthand) Registers a new TelnetOptionHandler for this telnet client to use.
void	deleteOptionHandler(int optcode) Unregisters a TelnetOptionHandler.
void	disconnect() Disconnects the telnet session, closing the input and output streams as well as the socket.
InputStream	getInputStream() Returns the telnet connection input stream.
boolean	getLocalOptionState(int option) Returns the state of the option on the local side.
OutputStream	getOutputStream() Returns the telnet connection output stream.
boolean	getReaderThread() Gets the status of the reader thread.
boolean	getRemoteOptionState(int option) Returns the state of the option on the remote side.
void	registerNotifHandler(TelnetNotificationHandler notifhand) Registers a notification handler to which will be sent notifications of received telnet option negotiation commands.
void	registerSpyStream(OutputStream spystream) Registers an OutputStream for spying what's going on in the TelnetClient session.
boolean	sendAYT(long timeout) Sends an Are You There sequence and waits for the result.
void	setReaderThread(boolean flag) Sets the status of the reader thread.
void	stopSpyStream() Stops spying this TelnetClient.
void	unregisterNotifHandler() Unregisters the current notification handler.
protected void	_connectAction_() Handles special connection requirements.

Field Detail

readerThread

protected boolean readerThread

Constructor Detail

TelnetClient

public TelnetClient()

Default TelnetClient constructor.

TelnetClient

public TelnetClient(String termtype)

Method Detail

addOptionHandler

public void addOptionHandler(TelnetOptionHandler opthand)

Registers a new TelnetOptionHandler for this telnet client to use.

Parameters: opthand - option handler to be registered.

Throws: InvalidTelnetOptionException

deleteOptionHandler

public void deleteOptionHandler(int optcode)

Unregisters a TelnetOptionHandler.

Parameters: optcode - Code of the option to be unregistered.

Throws: InvalidTelnetOptionException

disconnect

public void disconnect()

Disconnects the telnet session, closing the input and output streams as well as the socket. If you have references to the input and output streams of the telnet connection, you should not close them yourself, but rather call disconnect to properly close the connection.

getInputStream

public InputStream getInputStream()

Returns the telnet connection input stream. You should not close the stream when you finish with it. Rather, you should call {@link #disconnect disconnect }.

Returns: The telnet connection input stream.

getLocalOptionState

public boolean getLocalOptionState(int option)

Returns the state of the option on the local side.

Parameters: option - Option to be checked.

Returns: The state of the option on the local side.

getOutputStream

public OutputStream getOutputStream()

Returns the telnet connection output stream. You should not close the stream when you finish with it. Rather, you should call {@link #disconnect disconnect }.

Returns: The telnet connection output stream.