|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.net.SocketClient org.apache.commons.net.telnet.TelnetClient
public class TelnetClient
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
connect
method. Then an InputStream and OutputStream for sending and
receiving data over the Telnet connection can be obtained by
using the getInputStream()
and
getOutputStream()
methods.
When you finish using the streams, you must call
disconnect
rather than simply
closing the streams.
Field Summary | |
---|---|
protected boolean |
readerThread
|
protected static int |
TERMINAL_TYPE
Terminal type option |
protected static int |
TERMINAL_TYPE_IS
Is (for subnegotiation) |
protected static int |
TERMINAL_TYPE_SEND
Send (for subnegotiation) |
Fields inherited from class org.apache.commons.net.SocketClient |
---|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL |
Constructor Summary | |
---|---|
TelnetClient()
Default TelnetClient constructor, sets terminal-type VT100 . |
|
TelnetClient(String termtype)
Construct an instance with the specified terminal type. |
Method Summary | |
---|---|
protected void |
_connectAction_()
Handles special connection requirements. |
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 |
registerInputListener(TelnetInputListener listener)
Register a listener to be notified when new incoming data is available to be read on the input stream . |
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 |
sendCommand(byte command)
Sends a command byte to the remote peer, adding the IAC prefix. |
void |
sendSubnegotiation(int[] message)
Sends a protocol-specific subnegotiation message to the remote peer. |
void |
setReaderThread(boolean flag)
Sets the status of the reader thread. |
void |
stopSpyStream()
Stops spying this TelnetClient. |
void |
unregisterInputListener()
Unregisters the current TelnetInputListener , if any. |
void |
unregisterNotifHandler()
Unregisters the current notification handler. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean readerThread
protected static final int TERMINAL_TYPE
protected static final int TERMINAL_TYPE_SEND
protected static final int TERMINAL_TYPE_IS
Constructor Detail |
---|
public TelnetClient()
VT100
.
public TelnetClient(String termtype)
termtype
- the terminal type to use, e.g. VT100
Method Detail |
---|
protected void _connectAction_() throws IOException
IOException
- If an error occurs during connection setup.public void disconnect() throws IOException
disconnect
in class SocketClient
IOException
- If there is an error closing the socket.public OutputStream getOutputStream()
disconnect
.
public InputStream getInputStream()
disconnect
.
public boolean getLocalOptionState(int option)
option
- - Option to be checked.
public boolean getRemoteOptionState(int option)
option
- - Option to be checked.
public boolean sendAYT(long timeout) throws IOException, IllegalArgumentException, InterruptedException
timeout
- - Time to wait for a response (millis.)
InterruptedException
IllegalArgumentException
IOException
public void sendSubnegotiation(int[] message) throws IOException, IllegalArgumentException
TelnetClient
will add the IAC SB & IAC SE framing bytes;
the first byte in message
should be the appropriate telnet
option code.
This method does not wait for any response. Subnegotiation messages
sent by the remote end can be handled by registering an approrpriate
TelnetOptionHandler
.
message
- option code followed by subnegotiation payload
IllegalArgumentException
- if message
has length zero
IOException
- if an I/O error occurs while writing the messagepublic void sendCommand(byte command) throws IOException, IllegalArgumentException
This method does not wait for any response. Messages
sent by the remote end can be handled by registering an approrpriate
TelnetOptionHandler
.
command
- the code for the command
IOException
- if an I/O error occurs while writing the message
IllegalArgumentException
public void addOptionHandler(TelnetOptionHandler opthand) throws InvalidTelnetOptionException, IOException
opthand
- - option handler to be registered.
InvalidTelnetOptionException
IOException
public void deleteOptionHandler(int optcode) throws InvalidTelnetOptionException, IOException
optcode
- - Code of the option to be unregistered.
InvalidTelnetOptionException
IOException
public void registerSpyStream(OutputStream spystream)
spystream
- - OutputStream on which session activity
will be echoed.public void stopSpyStream()
public void registerNotifHandler(TelnetNotificationHandler notifhand)
notifhand
- - TelnetNotificationHandler to be registeredpublic void unregisterNotifHandler()
public void setReaderThread(boolean flag)
When enabled, a seaparate internal reader thread is created for new
connections to read incoming data as it arrives. This results in
immediate handling of option negotiation, notifications, etc.
(at least until the fixed-size internal buffer fills up).
Otherwise, no thread is created an all negotiation and option
handling is deferred until a read() is performed on the
input stream
.
The reader thread must be enabled for TelnetInputListener
support.
When this method is invoked, the reader thread status will apply to all subsequent connections; the current connection (if any) is not affected.
flag
- true to enable the reader thread, false to disableregisterInputListener(org.apache.commons.net.telnet.TelnetInputListener)
public boolean getReaderThread()
public void registerInputListener(TelnetInputListener listener)
input stream
.
Only one listener is supported at a time.
More precisely, notifications are issued whenever the number of
bytes available for immediate reading (i.e., the value returned
by InputStream.available()
) transitions from zero to non-zero.
Note that (in general) multiple reads may be required to empty the
buffer and reset this notification, because incoming bytes are being
added to the internal buffer asynchronously.
Notifications are only supported when a reader thread
is enabled for the connection.
listener
- listener to be registered; replaces any previouspublic void unregisterInputListener()
TelnetInputListener
, if any.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |