org.apache.commons.net.telnet

Class TelnetOption

public class TelnetOption extends Object

The TelnetOption class cannot be instantiated and only serves as a storehouse for telnet option constants.

Details regarding Telnet option specification can be found in RFC 855.

Author: Daniel F. Savarese

See Also: Telnet

Field Summary
static intAPPROXIMATE_MESSAGE_SIZE
static intAUTHENTICATION
static intBINARY
static intBYTE_MACRO
static intDATA_ENTRY_TERMINAL
static intECHO
static intENCRYPTION
static intEND_OF_RECORD
static intEXTENDED_ASCII
static intEXTENDED_OPTIONS_LIST
static intFORCE_LOGOUT
static intLINEMODE
static intMAX_OPTION_VALUE
The maximum value an option code can have.
static intNEGOTIATE_CARRIAGE_RETURN
static intNEGOTIATE_FORMFEED
static intNEGOTIATE_HORIZONTAL_TAB
static intNEGOTIATE_HORIZONTAL_TAB_STOP
static intNEGOTIATE_LINEFEED
static intNEGOTIATE_OUTPUT_LINE_WIDTH
static intNEGOTIATE_OUTPUT_PAGE_SIZE
static intNEGOTIATE_VERTICAL_TAB
static intNEGOTIATE_VERTICAL_TAB_STOP
static intNEW_ENVIRONMENT_VARIABLES
static intOLD_ENVIRONMENT_VARIABLES
static intOUTPUT_MARKING
static intPREPARE_TO_RECONNECT
static intREGIME_3270
static intREMOTE_CONTROLLED_TRANSMISSION
static intREMOTE_FLOW_CONTROL
static intSEND_LOCATION
static intSTATUS
static intSUPDUP
static intSUPDUP_OUTPUT
static intSUPPRESS_GO_AHEAD
static intTACACS_USER_IDENTIFICATION
static intTERMINAL_LOCATION_NUMBER
static intTERMINAL_SPEED
static intTERMINAL_TYPE
static intTIMING_MARK
static intWINDOW_SIZE
static intX3_PAD
static intX_DISPLAY_LOCATION
Method Summary
static StringgetOption(int code)
Returns the string representation of the telnet protocol option corresponding to the given option code.
static booleanisValidOption(int code)
Determines if a given option code is valid.

Field Detail

APPROXIMATE_MESSAGE_SIZE

public static final int APPROXIMATE_MESSAGE_SIZE

AUTHENTICATION

public static final int AUTHENTICATION

BINARY

public static final int BINARY

BYTE_MACRO

public static final int BYTE_MACRO

DATA_ENTRY_TERMINAL

public static final int DATA_ENTRY_TERMINAL

ECHO

public static final int ECHO

ENCRYPTION

public static final int ENCRYPTION

END_OF_RECORD

public static final int END_OF_RECORD

EXTENDED_ASCII

public static final int EXTENDED_ASCII

EXTENDED_OPTIONS_LIST

public static final int EXTENDED_OPTIONS_LIST

FORCE_LOGOUT

public static final int FORCE_LOGOUT

LINEMODE

public static final int LINEMODE

MAX_OPTION_VALUE

public static final int MAX_OPTION_VALUE
The maximum value an option code can have. This value is 255. **

NEGOTIATE_CARRIAGE_RETURN

public static final int NEGOTIATE_CARRIAGE_RETURN

NEGOTIATE_FORMFEED

public static final int NEGOTIATE_FORMFEED

NEGOTIATE_HORIZONTAL_TAB

public static final int NEGOTIATE_HORIZONTAL_TAB

NEGOTIATE_HORIZONTAL_TAB_STOP

public static final int NEGOTIATE_HORIZONTAL_TAB_STOP

NEGOTIATE_LINEFEED

public static final int NEGOTIATE_LINEFEED

NEGOTIATE_OUTPUT_LINE_WIDTH

public static final int NEGOTIATE_OUTPUT_LINE_WIDTH

NEGOTIATE_OUTPUT_PAGE_SIZE

public static final int NEGOTIATE_OUTPUT_PAGE_SIZE

NEGOTIATE_VERTICAL_TAB

public static final int NEGOTIATE_VERTICAL_TAB

NEGOTIATE_VERTICAL_TAB_STOP

public static final int NEGOTIATE_VERTICAL_TAB_STOP

NEW_ENVIRONMENT_VARIABLES

public static final int NEW_ENVIRONMENT_VARIABLES

OLD_ENVIRONMENT_VARIABLES

public static final int OLD_ENVIRONMENT_VARIABLES

OUTPUT_MARKING

public static final int OUTPUT_MARKING

PREPARE_TO_RECONNECT

public static final int PREPARE_TO_RECONNECT

REGIME_3270

public static final int REGIME_3270

REMOTE_CONTROLLED_TRANSMISSION

public static final int REMOTE_CONTROLLED_TRANSMISSION

REMOTE_FLOW_CONTROL

public static final int REMOTE_FLOW_CONTROL

SEND_LOCATION

public static final int SEND_LOCATION

STATUS

public static final int STATUS

SUPDUP

public static final int SUPDUP

SUPDUP_OUTPUT

public static final int SUPDUP_OUTPUT

SUPPRESS_GO_AHEAD

public static final int SUPPRESS_GO_AHEAD

TACACS_USER_IDENTIFICATION

public static final int TACACS_USER_IDENTIFICATION

TERMINAL_LOCATION_NUMBER

public static final int TERMINAL_LOCATION_NUMBER

TERMINAL_SPEED

public static final int TERMINAL_SPEED

TERMINAL_TYPE

public static final int TERMINAL_TYPE

TIMING_MARK

public static final int TIMING_MARK

WINDOW_SIZE

public static final int WINDOW_SIZE

X3_PAD

public static final int X3_PAD

X_DISPLAY_LOCATION

public static final int X_DISPLAY_LOCATION

Method Detail

getOption

public static final String getOption(int code)
Returns the string representation of the telnet protocol option corresponding to the given option code.

Parameters: code The option code of the telnet protocol option

Returns: The string representation of the telnet protocol option.

isValidOption

public static final boolean isValidOption(int code)
Determines if a given option code is valid. Returns true if valid, false if not.

Parameters: code The option code to test.

Returns: True if the option code is valid, false if not.