|
|||||||||
| Home >> All >> org >> apache >> commons >> net >> [ telnet overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.apache.commons.net.telnet
Class TelnetOptionHandler
java.lang.Objectorg.apache.commons.net.telnet.TelnetOptionHandler
- Direct Known Subclasses:
- EchoOptionHandler, SimpleOptionHandler, SuppressGAOptionHandler, TerminalTypeOptionHandler
- public abstract class TelnetOptionHandler
- extends java.lang.Object
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.
| Field Summary | |
private boolean |
acceptLocal
true if the option should be accepted on the local side |
private boolean |
acceptRemote
true if the option should be accepted on the remote side |
private boolean |
doFlag
true if the option is active on the local side |
private boolean |
initialLocal
true if the option should be activated on the local side |
private boolean |
initialRemote
true if the option should be activated on the remote side |
private int |
optionCode
Option code |
private boolean |
willFlag
true if the option is active on the remote side |
| Constructor Summary | |
TelnetOptionHandler(int optcode,
boolean initlocal,
boolean initremote,
boolean acceptlocal,
boolean acceptremote)
Constructor for the TelnetOptionHandler. |
|
| Method Summary | |
abstract int[] |
answerSubnegotiation(int[] suboptionData,
int suboptionLength)
Method called upon reception of a subnegotiation for this option coming from the other end. |
boolean |
getAcceptLocal()
Returns a boolean indicating whether to accept a DO request coming from the other end. |
boolean |
getAcceptRemote()
Returns a boolean indicating whether to accept a WILL request coming from the other end. |
(package private) boolean |
getDo()
Returns a boolean indicating whether a DO request sent to the other side has been acknowledged. |
boolean |
getInitLocal()
Returns a boolean indicating whether to send a WILL request to the other end upon connection. |
boolean |
getInitRemote()
Returns a boolean indicating whether to send a DO request to the other end upon connection. |
int |
getOptionCode()
Returns the option code for this option. |
(package private) boolean |
getWill()
Returns a boolean indicating whether a WILL request sent to the other side has been acknowledged. |
void |
setAcceptLocal(boolean accept)
Set behaviour of the option for DO requests coming from the other end. |
void |
setAcceptRemote(boolean accept)
Set behaviour of the option for WILL requests coming from the other end. |
(package private) void |
setDo(boolean state)
Tells this option whether a DO request sent to the other side has been acknowledged (invoked by TelnetClient). |
void |
setInitLocal(boolean init)
Tells this option whether to send a WILL request upon connection. |
void |
setInitRemote(boolean init)
Tells this option whether to send a DO request upon connection. |
(package private) void |
setWill(boolean state)
Tells this option whether a WILL request sent to the other side has been acknowledged (invoked by TelnetClient). |
abstract 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). |
abstract 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). |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
optionCode
private int optionCode
- Option code
initialLocal
private boolean initialLocal
- true if the option should be activated on the local side
initialRemote
private boolean initialRemote
- true if the option should be activated on the remote side
acceptLocal
private boolean acceptLocal
- true if the option should be accepted on the local side
acceptRemote
private boolean acceptRemote
- true if the option should be accepted on the remote side
doFlag
private boolean doFlag
- true if the option is active on the local side
willFlag
private boolean willFlag
- true if the option is active on the remote side
| Constructor Detail |
TelnetOptionHandler
public TelnetOptionHandler(int optcode,
boolean initlocal,
boolean initremote,
boolean acceptlocal,
boolean acceptremote)
- 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.
| Method Detail |
getOptionCode
public int getOptionCode()
- Returns the option code for this option.
getAcceptLocal
public boolean getAcceptLocal()
- Returns a boolean indicating whether to accept a DO
request coming from the other end.
getAcceptRemote
public boolean getAcceptRemote()
- Returns a boolean indicating whether to accept a WILL
request coming from the other end.
setAcceptLocal
public void setAcceptLocal(boolean accept)
- Set behaviour of the option for DO requests coming from
the other end.
setAcceptRemote
public void setAcceptRemote(boolean accept)
- Set behaviour of the option for WILL requests coming from
the other end.
getInitLocal
public boolean getInitLocal()
- Returns a boolean indicating whether to send a WILL request
to the other end upon connection.
getInitRemote
public boolean getInitRemote()
- Returns a boolean indicating whether to send a DO request
to the other end upon connection.
setInitLocal
public void setInitLocal(boolean init)
- Tells this option whether to send a WILL request upon connection.
setInitRemote
public void setInitRemote(boolean init)
- Tells this option whether to send a DO request upon connection.
answerSubnegotiation
public abstract 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.
startSubnegotiationLocal
public abstract 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.
startSubnegotiationRemote
public abstract 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.
getWill
boolean getWill()
- Returns a boolean indicating whether a WILL request sent to the other
side has been acknowledged.
setWill
void setWill(boolean state)
- Tells this option whether a WILL request sent to the other
side has been acknowledged (invoked by TelnetClient).
getDo
boolean getDo()
- Returns a boolean indicating whether a DO request sent to the other
side has been acknowledged.
setDo
void setDo(boolean state)
- Tells this option whether a DO request sent to the other
side has been acknowledged (invoked by TelnetClient).
|
|||||||||
| Home >> All >> org >> apache >> commons >> net >> [ telnet overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||