org.apache.commons.net.telnet
Class TelnetOption

java.lang.Object
  extended byorg.apache.commons.net.telnet.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.

Author:
Daniel F. Savarese
See Also:
Telnet, TelnetClient

Field Summary
private static int __FIRST_OPTION
           
private static int __LAST_OPTION
           
private static java.lang.String[] __optionString
           
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 X_DISPLAY_LOCATION
           
static int X3_PAD
           
 
Constructor Summary
private TelnetOption()
           
 
Method Summary
static java.lang.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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX_OPTION_VALUE

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

See Also:
Constant Field Values

BINARY

public static int BINARY

ECHO

public static int ECHO

PREPARE_TO_RECONNECT

public static int PREPARE_TO_RECONNECT

SUPPRESS_GO_AHEAD

public static int SUPPRESS_GO_AHEAD

APPROXIMATE_MESSAGE_SIZE

public static int APPROXIMATE_MESSAGE_SIZE

STATUS

public static int STATUS

TIMING_MARK

public static int TIMING_MARK

REMOTE_CONTROLLED_TRANSMISSION

public static int REMOTE_CONTROLLED_TRANSMISSION

NEGOTIATE_OUTPUT_LINE_WIDTH

public static int NEGOTIATE_OUTPUT_LINE_WIDTH

NEGOTIATE_OUTPUT_PAGE_SIZE

public static int NEGOTIATE_OUTPUT_PAGE_SIZE

NEGOTIATE_CARRIAGE_RETURN

public static int NEGOTIATE_CARRIAGE_RETURN

NEGOTIATE_HORIZONTAL_TAB_STOP

public static int NEGOTIATE_HORIZONTAL_TAB_STOP

NEGOTIATE_HORIZONTAL_TAB

public static int NEGOTIATE_HORIZONTAL_TAB

NEGOTIATE_FORMFEED

public static int NEGOTIATE_FORMFEED

NEGOTIATE_VERTICAL_TAB_STOP

public static int NEGOTIATE_VERTICAL_TAB_STOP

NEGOTIATE_VERTICAL_TAB

public static int NEGOTIATE_VERTICAL_TAB

NEGOTIATE_LINEFEED

public static int NEGOTIATE_LINEFEED

EXTENDED_ASCII

public static int EXTENDED_ASCII

FORCE_LOGOUT

public static int FORCE_LOGOUT

BYTE_MACRO

public static int BYTE_MACRO

DATA_ENTRY_TERMINAL

public static int DATA_ENTRY_TERMINAL

SUPDUP

public static int SUPDUP

SUPDUP_OUTPUT

public static int SUPDUP_OUTPUT

SEND_LOCATION

public static int SEND_LOCATION

TERMINAL_TYPE

public static int TERMINAL_TYPE

END_OF_RECORD

public static int END_OF_RECORD

TACACS_USER_IDENTIFICATION

public static int TACACS_USER_IDENTIFICATION

OUTPUT_MARKING

public static int OUTPUT_MARKING

TERMINAL_LOCATION_NUMBER

public static int TERMINAL_LOCATION_NUMBER

REGIME_3270

public static int REGIME_3270

X3_PAD

public static int X3_PAD

WINDOW_SIZE

public static int WINDOW_SIZE

TERMINAL_SPEED

public static int TERMINAL_SPEED

REMOTE_FLOW_CONTROL

public static int REMOTE_FLOW_CONTROL

LINEMODE

public static int LINEMODE

X_DISPLAY_LOCATION

public static int X_DISPLAY_LOCATION

OLD_ENVIRONMENT_VARIABLES

public static int OLD_ENVIRONMENT_VARIABLES

AUTHENTICATION

public static int AUTHENTICATION

ENCRYPTION

public static int ENCRYPTION

NEW_ENVIRONMENT_VARIABLES

public static int NEW_ENVIRONMENT_VARIABLES

EXTENDED_OPTIONS_LIST

public static int EXTENDED_OPTIONS_LIST

__FIRST_OPTION

private static int __FIRST_OPTION

__LAST_OPTION

private static int __LAST_OPTION

__optionString

private static final java.lang.String[] __optionString
Constructor Detail

TelnetOption

private TelnetOption()
Method Detail

getOption

public static final java.lang.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.