org.apache.commons.net.telnet

Class TelnetOption


public class TelnetOption
extends java.lang.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.

See Also:
org.apache.commons.net.telnet.Telnet, TelnetClient

Field Summary

static int
APPROXIMATE_MESSAGE_SIZE
static int
AUTHENTICATION
static int
BINARY
static int
BYTE_MACRO
static int
DATA_ENTRY_TERMINAL
static int
ECHO
static int
ENCRYPTION
static int
END_OF_RECORD
static int
EXTENDED_ASCII
static int
EXTENDED_OPTIONS_LIST
static int
FORCE_LOGOUT
static int
LINEMODE
static int
MAX_OPTION_VALUE
The maximum value an option code can have.
static int
NEGOTIATE_CARRIAGE_RETURN
static int
NEGOTIATE_FORMFEED
static int
NEGOTIATE_HORIZONTAL_TAB
static int
NEGOTIATE_HORIZONTAL_TAB_STOP
static int
NEGOTIATE_LINEFEED
static int
NEGOTIATE_OUTPUT_LINE_WIDTH
static int
NEGOTIATE_OUTPUT_PAGE_SIZE
static int
NEGOTIATE_VERTICAL_TAB
static int
NEGOTIATE_VERTICAL_TAB_STOP
static int
NEW_ENVIRONMENT_VARIABLES
static int
OLD_ENVIRONMENT_VARIABLES
static int
OUTPUT_MARKING
static int
PREPARE_TO_RECONNECT
static int
REGIME_3270
static int
REMOTE_CONTROLLED_TRANSMISSION
static int
REMOTE_FLOW_CONTROL
static int
SEND_LOCATION
static int
STATUS
static int
SUPDUP
static int
SUPDUP_OUTPUT
static int
SUPPRESS_GO_AHEAD
static int
TACACS_USER_IDENTIFICATION
static int
TERMINAL_LOCATION_NUMBER
static int
TERMINAL_SPEED
static int
TERMINAL_TYPE
static int
TIMING_MARK
static int
WINDOW_SIZE
static int
X3_PAD
static int
X_DISPLAY_LOCATION

Method Summary

static String
getOption(int code)
Returns the string representation of the telnet protocol option corresponding to the given option code.
static boolean
isValidOption(int code)
Determines if a given option code is valid.

Field Details

APPROXIMATE_MESSAGE_SIZE

public static int APPROXIMATE_MESSAGE_SIZE


AUTHENTICATION

public static int AUTHENTICATION


BINARY

public static int BINARY


BYTE_MACRO

public static int BYTE_MACRO


DATA_ENTRY_TERMINAL

public static int DATA_ENTRY_TERMINAL


ECHO

public static int ECHO


ENCRYPTION

public static int ENCRYPTION


END_OF_RECORD

public static int END_OF_RECORD


EXTENDED_ASCII

public static int EXTENDED_ASCII


EXTENDED_OPTIONS_LIST

public static int EXTENDED_OPTIONS_LIST


FORCE_LOGOUT

public static int FORCE_LOGOUT


LINEMODE

public static int LINEMODE


MAX_OPTION_VALUE

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

Field Value:
255


NEGOTIATE_CARRIAGE_RETURN

public static int NEGOTIATE_CARRIAGE_RETURN


NEGOTIATE_FORMFEED

public static int NEGOTIATE_FORMFEED


NEGOTIATE_HORIZONTAL_TAB

public static int NEGOTIATE_HORIZONTAL_TAB


NEGOTIATE_HORIZONTAL_TAB_STOP

public static int NEGOTIATE_HORIZONTAL_TAB_STOP


NEGOTIATE_LINEFEED

public static int NEGOTIATE_LINEFEED


NEGOTIATE_OUTPUT_LINE_WIDTH

public static int NEGOTIATE_OUTPUT_LINE_WIDTH


NEGOTIATE_OUTPUT_PAGE_SIZE

public static int NEGOTIATE_OUTPUT_PAGE_SIZE


NEGOTIATE_VERTICAL_TAB

public static int NEGOTIATE_VERTICAL_TAB


NEGOTIATE_VERTICAL_TAB_STOP

public static int NEGOTIATE_VERTICAL_TAB_STOP


NEW_ENVIRONMENT_VARIABLES

public static int NEW_ENVIRONMENT_VARIABLES


OLD_ENVIRONMENT_VARIABLES

public static int OLD_ENVIRONMENT_VARIABLES


OUTPUT_MARKING

public static int OUTPUT_MARKING


PREPARE_TO_RECONNECT

public static int PREPARE_TO_RECONNECT


REGIME_3270

public static int REGIME_3270


REMOTE_CONTROLLED_TRANSMISSION

public static int REMOTE_CONTROLLED_TRANSMISSION


REMOTE_FLOW_CONTROL

public static int REMOTE_FLOW_CONTROL


SEND_LOCATION

public static int SEND_LOCATION


STATUS

public static int STATUS


SUPDUP

public static int SUPDUP


SUPDUP_OUTPUT

public static int SUPDUP_OUTPUT


SUPPRESS_GO_AHEAD

public static int SUPPRESS_GO_AHEAD


TACACS_USER_IDENTIFICATION

public static int TACACS_USER_IDENTIFICATION


TERMINAL_LOCATION_NUMBER

public static int TERMINAL_LOCATION_NUMBER


TERMINAL_SPEED

public static int TERMINAL_SPEED


TERMINAL_TYPE

public static int TERMINAL_TYPE


TIMING_MARK

public static int TIMING_MARK


WINDOW_SIZE

public static int WINDOW_SIZE


X3_PAD

public static int X3_PAD


X_DISPLAY_LOCATION

public static int X_DISPLAY_LOCATION

Method Details

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.