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:
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 final int APPROXIMATE_MESSAGE_SIZE
Field Value:
4

AUTHENTICATION

public static final int AUTHENTICATION
Field Value:
37

BINARY

public static final int BINARY
Field Value:
0

BYTE_MACRO

public static final int BYTE_MACRO
Field Value:
19

DATA_ENTRY_TERMINAL

public static final int DATA_ENTRY_TERMINAL
Field Value:
20

ECHO

public static final int ECHO
Field Value:
1

ENCRYPTION

public static final int ENCRYPTION
Field Value:
38

END_OF_RECORD

public static final int END_OF_RECORD
Field Value:
25

EXTENDED_ASCII

public static final int EXTENDED_ASCII
Field Value:
17

EXTENDED_OPTIONS_LIST

public static final int EXTENDED_OPTIONS_LIST
Field Value:
255

FORCE_LOGOUT

public static final int FORCE_LOGOUT
Field Value:
18

LINEMODE

public static final int LINEMODE
Field Value:
34

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 final int NEGOTIATE_CARRIAGE_RETURN
Field Value:
10

NEGOTIATE_FORMFEED

public static final int NEGOTIATE_FORMFEED
Field Value:
13

NEGOTIATE_HORIZONTAL_TAB

public static final int NEGOTIATE_HORIZONTAL_TAB
Field Value:
12

NEGOTIATE_HORIZONTAL_TAB_STOP

public static final int NEGOTIATE_HORIZONTAL_TAB_STOP
Field Value:
11

NEGOTIATE_LINEFEED

public static final int NEGOTIATE_LINEFEED
Field Value:
16

NEGOTIATE_OUTPUT_LINE_WIDTH

public static final int NEGOTIATE_OUTPUT_LINE_WIDTH
Field Value:
8

NEGOTIATE_OUTPUT_PAGE_SIZE

public static final int NEGOTIATE_OUTPUT_PAGE_SIZE
Field Value:
9

NEGOTIATE_VERTICAL_TAB

public static final int NEGOTIATE_VERTICAL_TAB
Field Value:
15

NEGOTIATE_VERTICAL_TAB_STOP

public static final int NEGOTIATE_VERTICAL_TAB_STOP
Field Value:
14

NEW_ENVIRONMENT_VARIABLES

public static final int NEW_ENVIRONMENT_VARIABLES
Field Value:
39

OLD_ENVIRONMENT_VARIABLES

public static final int OLD_ENVIRONMENT_VARIABLES
Field Value:
36

OUTPUT_MARKING

public static final int OUTPUT_MARKING
Field Value:
27

PREPARE_TO_RECONNECT

public static final int PREPARE_TO_RECONNECT
Field Value:
2

REGIME_3270

public static final int REGIME_3270
Field Value:
29

REMOTE_CONTROLLED_TRANSMISSION

public static final int REMOTE_CONTROLLED_TRANSMISSION
Field Value:
7

REMOTE_FLOW_CONTROL

public static final int REMOTE_FLOW_CONTROL
Field Value:
33

SEND_LOCATION

public static final int SEND_LOCATION
Field Value:
23

STATUS

public static final int STATUS
Field Value:
5

SUPDUP

public static final int SUPDUP
Field Value:
21

SUPDUP_OUTPUT

public static final int SUPDUP_OUTPUT
Field Value:
22

SUPPRESS_GO_AHEAD

public static final int SUPPRESS_GO_AHEAD
Field Value:
3

TACACS_USER_IDENTIFICATION

public static final int TACACS_USER_IDENTIFICATION
Field Value:
26

TERMINAL_LOCATION_NUMBER

public static final int TERMINAL_LOCATION_NUMBER
Field Value:
28

TERMINAL_SPEED

public static final int TERMINAL_SPEED
Field Value:
32

TERMINAL_TYPE

public static final int TERMINAL_TYPE
Field Value:
24

TIMING_MARK

public static final int TIMING_MARK
Field Value:
6

WINDOW_SIZE

public static final int WINDOW_SIZE
Field Value:
31

X3_PAD

public static final int X3_PAD
Field Value:
30

X_DISPLAY_LOCATION

public static final int X_DISPLAY_LOCATION
Field Value:
35

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.