File	Doc	Category	Size	Date	Package
TelnetOptionHandler.java	API Doc	Apache Commons NET 1.4.1 API	8123	Sat Dec 03 10:05:50 GMT 2005	org.apache.commons.net.telnet

TelnetOptionHandler

• java.lang.Object

Fields Summary
private int	optionCode Option code
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 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	willFlag true if the option is active on the remote side

Constructors Summary

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. param optcode - Option code. param initlocal - if set to true, a WILL is sent upon connection. param initremote - if set to true, a DO is sent upon connection. param acceptlocal - if set to true, any DO request is accepted. param acceptremote - if set to true, any WILL request is accepted. optionCode = optcode; initialLocal = initlocal; initialRemote = initremote; acceptLocal = acceptlocal; acceptRemote = acceptremote;

Methods Summary
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. param suboptionData - the sequence received, whithout IAC SB & IAC SE param suboptionLength - the length of data in suboption_data return response to be sent to the subnegotiation sequence. TelnetClient will add IAC SB & IAC SE. null means no response
public boolean	getAcceptLocal() Returns a boolean indicating whether to accept a DO request coming from the other end. return true if a DO request shall be accepted. return (acceptLocal);
public boolean	getAcceptRemote() Returns a boolean indicating whether to accept a WILL request coming from the other end. return true if a WILL request shall be accepted. return (acceptRemote);
boolean	getDo() Returns a boolean indicating whether a DO request sent to the other side has been acknowledged. return true if a DO sent to the other side has been acknowledged. return doFlag;
public boolean	getInitLocal() Returns a boolean indicating whether to send a WILL request to the other end upon connection. return true if a WILL request shall be sent upon connection. return (initialLocal);
public boolean	getInitRemote() Returns a boolean indicating whether to send a DO request to the other end upon connection. return true if a DO request shall be sent upon connection. return (initialRemote);
public int	getOptionCode() Returns the option code for this option. return Option code. return (optionCode);
boolean	getWill() Returns a boolean indicating whether a WILL request sent to the other side has been acknowledged. return true if a WILL sent to the other side has been acknowledged. return willFlag;
public void	setAcceptLocal(boolean accept) Set behaviour of the option for DO requests coming from the other end. param accept - if true, subsequent DO requests will be accepted. acceptLocal = accept;
public void	setAcceptRemote(boolean accept) Set behaviour of the option for WILL requests coming from the other end. param accept - if true, subsequent WILL requests will be accepted. acceptRemote = accept;
void	setDo(boolean state) Tells this option whether a DO request sent to the other side has been acknowledged (invoked by TelnetClient). param state - if true, a DO request has been acknowledged. doFlag = state;
public void	setInitLocal(boolean init) Tells this option whether to send a WILL request upon connection. param init - if true, a WILL request will be sent upon subsequent connections. initialLocal = init;
public void	setInitRemote(boolean init) Tells this option whether to send a DO request upon connection. param init - if true, a DO request will be sent upon subsequent connections. initialRemote = init;
void	setWill(boolean state) Tells this option whether a WILL request sent to the other side has been acknowledged (invoked by TelnetClient). param state - if true, a WILL request has been acknowledged. willFlag = state;
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. return subnegotiation sequence to be sent by TelnetClient. TelnetClient will add IAC SB & IAC SE. null means no subnegotiation.
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. return subnegotiation sequence to be sent by TelnetClient. TelnetClient will add IAC SB & IAC SE. null means no subnegotiation.