com.iizix.term.prop

Class TelnetCommProps

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.prop.SocketCommProps

com.iizix.term.prop.TelnetCommProps

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable

Direct Known Subclasses:

TerminalProps

public class TelnetCommProps
extends SocketCommProps

This property container contains all properties required for Telnet 3270 and 5250 connections, and extends the SocketProp used for Socket properties.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_AUTO_RECONNECT_ATTEMPTS The default attempts count for auto reconnect session (default = 20).
static int	DEFAULT_AUTO_RECONNECT_INTERVAL The default interval used for auto reconnect session (in seconds, default = 3).
static int	DEFAULT_KEEP_ALIVE_INTERVAL The default interval used for Keep Alive (in seconds, default = 30).

Fields inherited from class com.iizix.prop.PropCnr

EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Constructor and Description
TelnetCommProps() Creates the Telnet property container without a name.
TelnetCommProps(Atom propertyAtom) Creates the Telnet property container with the specified name.

Method Summary

Modifier and Type	Method and Description
boolean	do3270NumericFieldOverride() Flag indicating 3270 NUMERIC FIELD OVERRIDE option.
boolean	doAutoReconnect() Flag for auto-reconnection of telnet session.
boolean	doTN3270E() Flag indicating 3270 host will do TN3270-E.
String	get5250KbdType() Gets the keyboard type (5250-specific).
int	getAutoReconnectAttempts() Gets the auto-reconnect attempts in milliseconds.
int	getAutoReconnectInterval() Gets the auto-reconnect interval in milliseconds.
String	getHostCodepage() Gets host codepage (default Cp037 = US English).
int	getKeepAliveTimeout() Gets the keep-alive timeout in milliseconds.
String	getLUName() Gets the LU name for the terminal session.
String[]	getTerminalTypes() Gets the terminal types as a String array.
void	set3270NumericFieldOverride(boolean do3270NumericFieldOverride) Sets the flag indicating 3270 NUMERIC FIELD OVERRIDE option.
void	set5250KbdType(String kbdType) Sets the keyboard type (5250-specific).
void	setAutoReconnect(boolean autoReconnect) Sets the flag for auto-reconnection of telnet session.
void	setAutoReconnectAttempts(int attempts) Sets the auto-reconnect attempts, 0=infinite.
void	setAutoReconnectInterval(int interval) Sets the auto-reconnect intervals in milliseconds.
void	setDoTN3270E(boolean doTN3270E) Sets the flag indicating host type (5250 or 3270).
void	setHostCodepage(String hostCodepage) Sets host codepage.
void	setKeepAliveNOP(boolean useNOP) Sets how the Telnet keep-alive is processed.
void	setKeepAliveTimeout(int timeout) Sets the keep-alive timeout in milliseconds.
void	setLUName(String luName) Sets the LU name for the terminal session.
void	setTerminalTypes(String[] terminalTypes) Sets the terminal types from a String array.
boolean	useKeepAliveNOP() Gets how the Telnet keep-alive is processed: true = NOP (default), false = TimingMark (TM).

Methods inherited from class com.iizix.prop.SocketCommProps

clone, createSecureProps, doResolveHostNames, getBindAddress, getHost, getPort, getProxyHost, getProxyPort, getProxyPW, getProxyPW, getProxyType, getProxyUser, getSecureProps, isSecure, isVerbose, setBindAddress, setHost, setPort, setProxyHost, setProxyPort, setProxyType, setProxyUser, setResolveHostNames, setSecure, setSecureProps, setVerbose, setWebSocket, useWebSocket

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IPropCnr

canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Field Detail

DEFAULT_KEEP_ALIVE_INTERVAL

public static final int DEFAULT_KEEP_ALIVE_INTERVAL

The default interval used for Keep Alive (in seconds, default = 30).

See Also:

Constant Field Values

DEFAULT_AUTO_RECONNECT_INTERVAL

public static final int DEFAULT_AUTO_RECONNECT_INTERVAL

The default interval used for auto reconnect session (in seconds, default = 3).

See Also:

Constant Field Values

DEFAULT_AUTO_RECONNECT_ATTEMPTS

public static final int DEFAULT_AUTO_RECONNECT_ATTEMPTS

The default attempts count for auto reconnect session (default = 20).

See Also:

Constant Field Values

Constructor Detail

TelnetCommProps

public TelnetCommProps()

Creates the Telnet property container without a name. The name must be set in all cases using the setPropertyAtom call.

TelnetCommProps

public TelnetCommProps(Atom propertyAtom)

Creates the Telnet property container with the specified name. All system-reserved names for components begins with "$".

Parameters:

propertyAtom - the name of the component, unique within it's parent.

Method Detail

getLUName

public String getLUName()

Gets the LU name for the terminal session.

Returns:

The LU name or null for none.

setLUName

public void setLUName(String luName)

Sets the LU name for the terminal session.

Parameters:

luName - The LU name.

doAutoReconnect

public boolean doAutoReconnect()

Flag for auto-reconnection of telnet session.

Returns:

false (default) or true for auto-reconnection.

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)

Sets the flag for auto-reconnection of telnet session.

Parameters:

autoReconnect - false or true for auto-reconnection.

getAutoReconnectInterval

public int getAutoReconnectInterval()

Gets the auto-reconnect interval in milliseconds.

Returns:

The interval in ms, defaults to 1000*DEFAULT_AUTO_RECONNECT_INTERVAL.

setAutoReconnectInterval

public void setAutoReconnectInterval(int interval)

Sets the auto-reconnect intervals in milliseconds.

Parameters:

interval - New interval.

getAutoReconnectAttempts

public int getAutoReconnectAttempts()

Gets the auto-reconnect attempts in milliseconds.

Returns:

The attempts count, defaults to DEFAULT_AUTO_RECONNECT_ATTEMPTS, 0=infinite retry.

setAutoReconnectAttempts

public void setAutoReconnectAttempts(int attempts)

Sets the auto-reconnect attempts, 0=infinite.

Parameters:

attempts - Max count of reconnect attempts.

doTN3270E

public boolean doTN3270E()

Flag indicating 3270 host will do TN3270-E.

Returns:

true if TN3270-E is used, false (default) otherwise.

setDoTN3270E

public void setDoTN3270E(boolean doTN3270E)

Sets the flag indicating host type (5250 or 3270).

Parameters:

doTN3270E - true if TN3270-E is used, false otherwise.

do3270NumericFieldOverride

public boolean do3270NumericFieldOverride()

Flag indicating 3270 NUMERIC FIELD OVERRIDE option.

Returns:

true if the option is active, false (default) otherwise.

set3270NumericFieldOverride

public void set3270NumericFieldOverride(boolean do3270NumericFieldOverride)

Sets the flag indicating 3270 NUMERIC FIELD OVERRIDE option.

Parameters:

do3270NumericFieldOverride - true if the option is active, false otherwise.

getKeepAliveTimeout

public int getKeepAliveTimeout()

Gets the keep-alive timeout in milliseconds.

Returns:

0 = no timeout, otherwise a millisecond timeout value.

setKeepAliveTimeout

public void setKeepAliveTimeout(int timeout)

Sets the keep-alive timeout in milliseconds.

Parameters:

timeout - 0 = no timeout (default), otherwise a millisecond timeout value.

useKeepAliveNOP

public boolean useKeepAliveNOP()

Gets how the Telnet keep-alive is processed: true = NOP (default), false = TimingMark (TM).

Returns:

true = NOP, false = TM.

setKeepAliveNOP

public void setKeepAliveNOP(boolean useNOP)

Sets how the Telnet keep-alive is processed.

Parameters:

useNOP - true = NOP, false = TimingMark (TM).

getTerminalTypes

public String[] getTerminalTypes()

Gets the terminal types as a String array.

Returns:

The terminal types, never null.

setTerminalTypes

public void setTerminalTypes(String[] terminalTypes)

Sets the terminal types from a String array.

Parameters:

terminalTypes - The terminal types accepted.

getHostCodepage

public String getHostCodepage()

Gets host codepage (default Cp037 = US English).

Returns:

The host codepage.

setHostCodepage

public void setHostCodepage(String hostCodepage)

Sets host codepage.

Parameters:

hostCodepage - The String for the host codepage.

get5250KbdType

public String get5250KbdType()

Gets the keyboard type (5250-specific).

Returns:

null if not defined, otherwise the keyboard type.

set5250KbdType

public void set5250KbdType(String kbdType)

Sets the keyboard type (5250-specific).

Parameters:

kbdType - The keyboard type.