SSH Factory

com.jscape.inet.telnet
Interface TelnetListener

All Known Implementing Classes:
TelnetAdapter, TelnetTask

public interface TelnetListener

Implements methods for capturing events sourced from Telnet class. Typicaly your application will implement this interface to capture the following events :

TelnetConnectedEvent
TelnetDisconnectedEvent
DoOptionEvent
DontOptionEvent
WillOptionEvent
WontOptionEvent
DoSubOptionEvent
TelnetDataReceivedEvent

In addition to implementing this interface your application should register itself as an EventListener which may look somewhat like this:

 public class Application ... implements TelnetListener
 {
  ...
  public ... initMethod(...)
  {
    Telnet telnet = new Telnet("myserver.com");
    telnet.addTelnetListener(this);
  }
  ...
 }
 


Method Summary
 void connected(TelnetConnectedEvent event)
          Invoked when Telnet connection is established.
 void dataReceived(TelnetDataReceivedEvent event)
          Invoked when data is received from Telnet server.
 void disconnected(TelnetDisconnectedEvent event)
          Invoked when Telnet connection is released.
 void dontOption(DontOptionEvent event)
          Invoked when a DONT OPTION (refuse client request to use option) command is received from the Telnet server.
 void doOption(DoOptionEvent event)
          Invoked when a DO OPTION (request client to use option) command is received from the Telnet server.
 void doSubOption(DoSubOptionEvent event)
          Invoked when SB OPTION (subnegotiation) command is received from Telnet server, typically after accepting a WILL OPTION command from Telnet server.
 void willOption(WillOptionEvent event)
          Invoked when a WILL OPTION (offer client to use option) command is received from the Telnet server.
 void wontOption(WontOptionEvent event)
          Invoked when a WONT OPTION (refuse clients offer to use option) command is received from the Telnet server.
 

Method Detail

connected

void connected(TelnetConnectedEvent event)
Invoked when Telnet connection is established. Option negotiation has not yet been completed at this point.

Parameters:
event - a TelnetConnectedEvent
See Also:
TelnetConnectedEvent, Telnet.connect()

disconnected

void disconnected(TelnetDisconnectedEvent event)
Invoked when Telnet connection is released. Disconnect can occur in many circumstances including IOException during socket read/write or manually invoking the Telnet#disconnect method

Parameters:
event - a TelnetDisconnectedEvent
See Also:
TelnetDisconnectedEvent, Telnet.disconnect()

doOption

void doOption(DoOptionEvent event)
Invoked when a DO OPTION (request client to use option) command is received from the Telnet server. Upon receiving DoOptionEvent invoke the Telnet#sendDontOption to refuse the option or Telnet#sentWillOption to accept the option.

Parameters:
event - a DoOptionEvent
See Also:
DoOptionEvent, TelnetOption, Telnet.sendDontOption(com.jscape.inet.telnet.TelnetOption), Telnet.sendWillOption(com.jscape.inet.telnet.TelnetOption)

dontOption

void dontOption(DontOptionEvent event)
Invoked when a DONT OPTION (refuse client request to use option) command is received from the Telnet server.

Parameters:
event - a DontOptionEvent
See Also:
DontOptionEvent, TelnetOption

willOption

void willOption(WillOptionEvent event)
Invoked when a WILL OPTION (offer client to use option) command is received from the Telnet server. Upon receiving WillOptionEvent invoke the Telnet#sendDontOption method to refuse the option or Telnet#sendDoOption method to accept the option.

Parameters:
event - a WillOptionEvent
See Also:
WillOptionEvent, TelnetOption, Telnet.sendDoOption(com.jscape.inet.telnet.TelnetOption), Telnet.sendDontOption(com.jscape.inet.telnet.TelnetOption)

wontOption

void wontOption(WontOptionEvent event)
Invoked when a WONT OPTION (refuse clients offer to use option) command is received from the Telnet server.

Parameters:
event - a WontOptionEvent
See Also:
WontOptionEvent, TelnetOption

doSubOption

void doSubOption(DoSubOptionEvent event)
Invoked when SB OPTION (subnegotiation) command is received from Telnet server, typically after accepting a WILL OPTION command from Telnet server. Upon receiving DoSupOptionEvent invoke the Telnet#sendOptionSubnegotiation to perform subnegotiation for the requested option.

Parameters:
event - a DoSubOptionEvent
See Also:
DoSubOptionEvent, Telnet.sendOptionSubnegotiation(com.jscape.inet.telnet.TelnetOption)

dataReceived

void dataReceived(TelnetDataReceivedEvent event)
Invoked when data is received from Telnet server.

Parameters:
event - a TelnetDataReceivedEvent
See Also:
TelnetDataReceivedEvent

SSH Factory

Copyright © JSCAPE LLC. 1999-2011. All Rights Reserved