| java.lang.Object
 org.apache.commons.net.telnet.TelnetOptionHandler
All known Subclasses: org.apache.commons.net.telnet.SuppressGAOptionHandler, org.apache.commons.net.telnet.TerminalTypeOptionHandler, org.apache.commons.net.telnet.EchoOptionHandler, org.apache.commons.net.telnet.SimpleOptionHandler,
| TelnetOptionHandler | | abstract public class TelnetOptionHandler (Code) | | The TelnetOptionHandler class is the base class to be used
for implementing handlers for telnet options.
TelnetOptionHandler implements basic option handling
functionality and defines abstract methods that must be
implemented to define subnegotiation behaviour.
author:
Bruno D'Avanzo |
| Constructor Summary | |
| public | TelnetOptionHandler(int optcode, boolean initlocal, boolean initremote, boolean acceptlocal, boolean acceptremote)
Constructor for the TelnetOptionHandler. |
| Method Summary | |
| abstract public int[] | answerSubnegotiation(int suboptionData, int suboptionLength)
Method called upon reception of a subnegotiation for this option
coming from the other end.
Must be implemented by the actual TelnetOptionHandler to specify
which response must be sent for the subnegotiation request.
Parameters:
suboptionData - - the sequence received, whithout IAC SB & IAC SE
Parameters:
suboptionLength - - the length of data in suboption_data response to be sent to the subnegotiation sequence. | | public boolean | getAcceptLocal()
Returns a boolean indicating whether to accept a DO
request coming from the other end. | | public boolean | getAcceptRemote()
Returns a boolean indicating whether to accept a WILL
request coming from the other end. | | boolean | getDo()
Returns a boolean indicating whether a DO request sent to the other
side has been acknowledged. | | public boolean | getInitLocal()
Returns a boolean indicating whether to send a WILL request
to the other end upon connection. | | public boolean | getInitRemote()
Returns a boolean indicating whether to send a DO request
to the other end upon connection. | | public int | getOptionCode()
Returns the option code for this option. | | boolean | getWill()
Returns a boolean indicating whether a WILL request sent to the other
side has been acknowledged. | | public void | setAcceptLocal(boolean accept)
Set behaviour of the option for DO requests coming from
the other end. | | public void | setAcceptRemote(boolean accept)
Set behaviour of the option for WILL requests coming from
the other end. | | void | setDo(boolean state)
Tells this option whether a DO request sent to the other
side has been acknowledged (invoked by TelnetClient). | | public void | setInitLocal(boolean init)
Tells this option whether to send a WILL request upon connection. | | public void | setInitRemote(boolean init)
Tells this option whether to send a DO request upon connection. | | void | setWill(boolean state)
Tells this option whether a WILL request sent to the other
side has been acknowledged (invoked by TelnetClient). | | abstract public int[] | startSubnegotiationLocal()
This method is invoked whenever this option is acknowledged active on
the local end (TelnetClient sent a WILL, remote side sent a DO).
The method is used to specify a subnegotiation sequence that will be
sent by TelnetClient when the option is activated.
subnegotiation sequence to be sent by TelnetClient. | | abstract public int[] | startSubnegotiationRemote()
This method is invoked whenever this option is acknowledged active on
the remote end (TelnetClient sent a DO, remote side sent a WILL).
The method is used to specify a subnegotiation sequence that will be
sent by TelnetClient when the option is activated.
subnegotiation sequence to be sent by TelnetClient. |
| TelnetOptionHandler | | public TelnetOptionHandler(int optcode, boolean initlocal, boolean initremote, boolean acceptlocal, boolean acceptremote)(Code) | | Constructor for the TelnetOptionHandler. Allows defining desired
initial setting for local/remote activation of this option and
behaviour in case a local/remote activation request for this
option is received.
Parameters:
optcode - - Option code.
Parameters:
initlocal - - if set to true, a WILL is sent upon connection.
Parameters:
initremote - - if set to true, a DO is sent upon connection.
Parameters:
acceptlocal - - if set to true, any DO request is accepted.
Parameters:
acceptremote - - if set to true, any WILL request is accepted. |
| answerSubnegotiation | | abstract public int[] answerSubnegotiation(int suboptionData, int suboptionLength)(Code) | | Method called upon reception of a subnegotiation for this option
coming from the other end.
Must be implemented by the actual TelnetOptionHandler to specify
which response must be sent for the subnegotiation request.
Parameters:
suboptionData - - the sequence received, whithout IAC SB & IAC SE
Parameters:
suboptionLength - - the length of data in suboption_data response to be sent to the subnegotiation sequence. TelnetClientwill add IAC SB & IAC SE. null means no response |
| getAcceptLocal | | public boolean getAcceptLocal()(Code) | | Returns a boolean indicating whether to accept a DO
request coming from the other end.
true if a DO request shall be accepted. |
| getAcceptRemote | | public boolean getAcceptRemote()(Code) | | Returns a boolean indicating whether to accept a WILL
request coming from the other end.
true if a WILL request shall be accepted. |
| getDo | | boolean getDo()(Code) | | Returns a boolean indicating whether a DO request sent to the other
side has been acknowledged.
true if a DO sent to the other side has been acknowledged. |
| getInitLocal | | public boolean getInitLocal()(Code) | | Returns a boolean indicating whether to send a WILL request
to the other end upon connection.
true if a WILL request shall be sent upon connection. |
| getInitRemote | | public boolean getInitRemote()(Code) | | Returns a boolean indicating whether to send a DO request
to the other end upon connection.
true if a DO request shall be sent upon connection. |
| getOptionCode | | public int getOptionCode()(Code) | | Returns the option code for this option.
Option code. |
| getWill | | boolean getWill()(Code) | | Returns a boolean indicating whether a WILL request sent to the other
side has been acknowledged.
true if a WILL sent to the other side has been acknowledged. |
| setAcceptLocal | | public void setAcceptLocal(boolean accept)(Code) | | Set behaviour of the option for DO requests coming from
the other end.
Parameters:
accept - - if true, subsequent DO requests will be accepted. |
| setAcceptRemote | | public void setAcceptRemote(boolean accept)(Code) | | Set behaviour of the option for WILL requests coming from
the other end.
Parameters:
accept - - if true, subsequent WILL requests will be accepted. |
| setDo | | void setDo(boolean state)(Code) | | Tells this option whether a DO request sent to the other
side has been acknowledged (invoked by TelnetClient).
Parameters:
state - - if true, a DO request has been acknowledged. |
| setInitLocal | | public void setInitLocal(boolean init)(Code) | | Tells this option whether to send a WILL request upon connection.
Parameters:
init - - if true, a WILL request will be sent upon subsequentconnections. |
| setInitRemote | | public void setInitRemote(boolean init)(Code) | | Tells this option whether to send a DO request upon connection.
Parameters:
init - - if true, a DO request will be sent upon subsequentconnections. |
| setWill | | void setWill(boolean state)(Code) | | Tells this option whether a WILL request sent to the other
side has been acknowledged (invoked by TelnetClient).
Parameters:
state - - if true, a WILL request has been acknowledged. |
| startSubnegotiationLocal | | abstract public int[] startSubnegotiationLocal()(Code) | | This method is invoked whenever this option is acknowledged active on
the local end (TelnetClient sent a WILL, remote side sent a DO).
The method is used to specify a subnegotiation sequence that will be
sent by TelnetClient when the option is activated.
subnegotiation sequence to be sent by TelnetClient. TelnetClientwill add IAC SB & IAC SE. null means no subnegotiation. |
| startSubnegotiationRemote | | abstract public int[] startSubnegotiationRemote()(Code) | | This method is invoked whenever this option is acknowledged active on
the remote end (TelnetClient sent a DO, remote side sent a WILL).
The method is used to specify a subnegotiation sequence that will be
sent by TelnetClient when the option is activated.
subnegotiation sequence to be sent by TelnetClient. TelnetClientwill add IAC SB & IAC SE. null means no subnegotiation. |
|
|